From 2c61c156566f7dd3d4a5108555dd6b71b2438a1a Mon Sep 17 00:00:00 2001
From: Christian Breunig <christian@breunig.cc>
Date: Wed, 19 Feb 2025 16:21:14 +0100
Subject: Intel: T6847: provide common build script for Out-Of-Tree drivers

Use one build script to rule all the Intel Git based drivers.
---
 scripts/package-build/linux-kernel/.gitignore      |   3 +-
 .../linux-kernel/build-intel-ixgbe.sh              |  78 ---------------
 .../linux-kernel/build-intel-ixgbevf.sh            | 105 ---------------------
 .../package-build/linux-kernel/build-intel-nic.sh  |  78 +++++++++++++++
 scripts/package-build/linux-kernel/build.py        |  19 ++--
 scripts/package-build/linux-kernel/package.toml    |  10 +-
 6 files changed, 95 insertions(+), 198 deletions(-)
 delete mode 100755 scripts/package-build/linux-kernel/build-intel-ixgbe.sh
 delete mode 100755 scripts/package-build/linux-kernel/build-intel-ixgbevf.sh
 create mode 100755 scripts/package-build/linux-kernel/build-intel-nic.sh

diff --git a/scripts/package-build/linux-kernel/.gitignore b/scripts/package-build/linux-kernel/.gitignore
index 6e18781a..f3a564a4 100644
--- a/scripts/package-build/linux-kernel/.gitignore
+++ b/scripts/package-build/linux-kernel/.gitignore
@@ -18,8 +18,7 @@
 # Intel Driver source
 i40e-*/
 igb-*/
-ethernet-linux-ixgbe/
-ixgbevf-*/
+ethernet-linux-*/
 vyos-intel-*/
 vyos-linux-firmware*/
 kernel-vars
diff --git a/scripts/package-build/linux-kernel/build-intel-ixgbe.sh b/scripts/package-build/linux-kernel/build-intel-ixgbe.sh
deleted file mode 100755
index b2736514..00000000
--- a/scripts/package-build/linux-kernel/build-intel-ixgbe.sh
+++ /dev/null
@@ -1,78 +0,0 @@
-#!/bin/sh
-CWD=$(pwd)
-KERNEL_VAR_FILE=${CWD}/kernel-vars
-
-if ! dpkg-architecture -iamd64; then
-    echo "Intel ixgbe is only buildable on amd64 platforms"
-    exit 0
-fi
-
-if [ ! -f ${KERNEL_VAR_FILE} ]; then
-    echo "Kernel variable file '${KERNEL_VAR_FILE}' does not exist, run ./build_kernel.sh first"
-    exit 1
-fi
-
-. ${KERNEL_VAR_FILE}
-
-if [ -z $KERNEL_DIR ]; then
-    echo "KERNEL_DIR not defined"
-    exit 1
-fi
-
-cd ${CWD}/ethernet-linux-ixgbe
-if [ -d .git ]; then
-    git clean --force -d -x
-    git reset --hard origin/main
-fi
-
-DRIVER_NAME="ixgbe"
-DRIVER_VERSION=$(git describe | sed s/^v//)
-
-# Build up Debian related variables required for packaging
-DEBIAN_ARCH=$(dpkg --print-architecture)
-DEBIAN_DIR="${CWD}/vyos-intel-${DRIVER_NAME}_${DRIVER_VERSION}_${DEBIAN_ARCH}"
-DEBIAN_CONTROL="${DEBIAN_DIR}/DEBIAN/control"
-DEBIAN_POSTINST="${CWD}/vyos-intel-ixgbe.postinst"
-
-# See https://vyos.dev/T6155
-# See https://vyos.dev/T6162
-PATCH_DIR=${CWD}/patches/ixgbe
-if [ -d $PATCH_DIR ]; then
-    for patch in $(ls ${PATCH_DIR})
-    do
-        echo "I: Apply patch: ${PATCH_DIR}/${patch}"
-        patch -p1 < ${PATCH_DIR}/${patch}
-    done
-fi
-
-echo "I: Compile Kernel module for Intel ${DRIVER_NAME} driver"
-make KSRC=${KERNEL_DIR} INSTALL_MOD_PATH=${DEBIAN_DIR} INSTALL_FW_PATH=${DEBIAN_DIR} -j $(getconf _NPROCESSORS_ONLN) -C src install
-
-if [ "x$?" != "x0" ]; then
-    exit 1
-fi
-
-if [ -f ${DEBIAN_DIR}.deb ]; then
-    rm ${DEBIAN_DIR}.deb
-fi
-
-# build Debian package
-echo "I: Building Debian package vyos-intel-${DRIVER_NAME}"
-cd ${CWD}
-
-# Sign generated Kernel modules
-${CWD}/sign-modules.sh ${DEBIAN_DIR}
-
-# delete non required files which are also present in the kernel package
-# und thus lead to duplicated files
-find ${DEBIAN_DIR} -name "modules.*" | xargs rm -f
-
-echo "#!/bin/sh" > ${DEBIAN_POSTINST}
-echo "/sbin/depmod -a ${KERNEL_VERSION}${KERNEL_SUFFIX}" >> ${DEBIAN_POSTINST}
-
-fpm --input-type dir --output-type deb --name vyos-intel-${DRIVER_NAME} \
-    --version ${DRIVER_VERSION} --deb-compression gz \
-    --maintainer "VyOS Package Maintainers <maintainers@vyos.net>" \
-    --description "Vendor based driver for Intel ${DRIVER_NAME}" \
-    --depends linux-image-${KERNEL_VERSION}${KERNEL_SUFFIX} \
-    --license "GPL2" -C ${DEBIAN_DIR} --after-install ${DEBIAN_POSTINST}
diff --git a/scripts/package-build/linux-kernel/build-intel-ixgbevf.sh b/scripts/package-build/linux-kernel/build-intel-ixgbevf.sh
deleted file mode 100755
index f0e4c89b..00000000
--- a/scripts/package-build/linux-kernel/build-intel-ixgbevf.sh
+++ /dev/null
@@ -1,105 +0,0 @@
-#!/bin/sh
-CWD=$(pwd)
-KERNEL_VAR_FILE=${CWD}/kernel-vars
-
-if ! dpkg-architecture -iamd64; then
-    echo "Intel ixgbevf is only buildable on amd64 platforms"
-    exit 0
-fi
-
-if [ ! -f ${KERNEL_VAR_FILE} ]; then
-    echo "Kernel variable file '${KERNEL_VAR_FILE}' does not exist, run ./build_kernel.sh first"
-    exit 1
-fi
-
-. ${KERNEL_VAR_FILE}
-
-url="https://sourceforge.net/projects/e1000/files/ixgbevf%20stable/4.18.9/ixgbevf-4.18.9.tar.gz"
-
-cd ${CWD}
-
-DRIVER_FILE=$(basename ${url} | sed -e s/tar_0/tar/)
-DRIVER_DIR="${DRIVER_FILE%.tar.gz}"
-DRIVER_NAME="ixgbevf"
-DRIVER_VERSION=$(echo ${DRIVER_DIR} | awk -F${DRIVER_NAME} '{print $2}' | sed 's/^-//')
-DRIVER_VERSION_EXTRA=""
-
-# Build up Debian related variables required for packaging
-DEBIAN_ARCH=$(dpkg --print-architecture)
-DEBIAN_DIR="${CWD}/vyos-intel-${DRIVER_NAME}_${DRIVER_VERSION}_${DEBIAN_ARCH}"
-DEBIAN_CONTROL="${DEBIAN_DIR}/DEBIAN/control"
-DEBIAN_POSTINST="${CWD}/vyos-intel-ixgbevf.postinst"
-
-# Fetch Intel driver source from SourceForge
-if [ -e ${DRIVER_FILE} ]; then
-    rm -f ${DRIVER_FILE}
-fi
-curl -L -o ${DRIVER_FILE} ${url}
-if [ "$?" -ne "0" ]; then
-    exit 1
-fi
-
-# Unpack archive
-if [ -d ${DRIVER_DIR} ]; then
-    rm -rf ${DRIVER_DIR}
-fi
-mkdir -p ${DRIVER_DIR}
-tar -C ${DRIVER_DIR} --strip-components=1 -xf ${DRIVER_FILE}
-
-cd ${DRIVER_DIR}/src
-if [ -z $KERNEL_DIR ]; then
-    echo "KERNEL_DIR not defined"
-    exit 1
-fi
-
-# See https://lore.kernel.org/lkml/f90837d0-810e-5772-7841-28d47c44d260@intel.com/
-echo "I: remove pci_enable_pcie_error_reporting() code no longer present in Kernel"
-sed -i '/.*pci_disable_pcie_error_reporting(pdev);/d' ixgbevf_main.c
-sed -i '/.*pci_enable_pcie_error_reporting(pdev);/d' ixgbevf_main.c
-
-echo "I: Compile Kernel module for Intel ${DRIVER_NAME} driver"
-make KSRC=${KERNEL_DIR} INSTALL_MOD_PATH=${DEBIAN_DIR} INSTALL_FW_PATH=${DEBIAN_DIR} -j $(getconf _NPROCESSORS_ONLN) install
-
-if [ "x$?" != "x0" ]; then
-    exit 1
-fi
-
-if [ -f ${DEBIAN_DIR}.deb ]; then
-    rm ${DEBIAN_DIR}.deb
-fi
-
-# build Debian package
-echo "I: Building Debian package vyos-intel-${DRIVER_NAME}"
-cd ${CWD}
-
-# Sign generated Kernel modules
-${CWD}/sign-modules.sh ${DEBIAN_DIR}
-
-# delete non required files which are also present in the kernel package
-# und thus lead to duplicated files
-find ${DEBIAN_DIR} -name "modules.*" | xargs rm -f
-
-echo "#!/bin/sh" > ${DEBIAN_POSTINST}
-echo "/sbin/depmod -a ${KERNEL_VERSION}${KERNEL_SUFFIX}" >> ${DEBIAN_POSTINST}
-
-fpm --input-type dir --output-type deb --name vyos-intel-${DRIVER_NAME} \
-    --version ${DRIVER_VERSION} --deb-compression gz \
-    --maintainer "VyOS Package Maintainers <maintainers@vyos.net>" \
-    --description "Vendor based driver for Intel ${DRIVER_NAME}" \
-    --depends linux-image-${KERNEL_VERSION}${KERNEL_SUFFIX} \
-    --license "GPL2" -C ${DEBIAN_DIR} --after-install ${DEBIAN_POSTINST}
-
-# echo "I: Cleanup ${DRIVER_NAME} source"
-# cd ${CWD}
-# if [ -e ${DRIVER_FILE} ]; then
-#     rm -f ${DRIVER_FILE}
-# fi
-# if [ -d ${DRIVER_DIR} ]; then
-#     rm -rf ${DRIVER_DIR}
-# fi
-# if [ -d ${DEBIAN_DIR} ]; then
-#     rm -rf ${DEBIAN_DIR}
-# fi
-# if [ -f ${DEBIAN_POSTINST} ]; then
-#     rm -f ${DEBIAN_POSTINST}
-# fi
diff --git a/scripts/package-build/linux-kernel/build-intel-nic.sh b/scripts/package-build/linux-kernel/build-intel-nic.sh
new file mode 100755
index 00000000..3e8bbb37
--- /dev/null
+++ b/scripts/package-build/linux-kernel/build-intel-nic.sh
@@ -0,0 +1,78 @@
+#!/bin/sh
+CWD=$(pwd)
+KERNEL_VAR_FILE=${CWD}/kernel-vars
+
+if ! dpkg-architecture -iamd64; then
+    echo "Intel drivers only buildable on amd64 platforms"
+    exit 0
+fi
+
+if [ ! -f ${KERNEL_VAR_FILE} ]; then
+    echo "Kernel variable file '${KERNEL_VAR_FILE}' does not exist, run ./build_kernel.sh first"
+    exit 1
+fi
+
+. ${KERNEL_VAR_FILE}
+
+if [ -z $KERNEL_DIR ]; then
+    echo "KERNEL_DIR not defined"
+    exit 1
+fi
+
+DRIVER_NAME=$1
+cd ${CWD}/ethernet-linux-${DRIVER_NAME}
+if [ -d .git ]; then
+    git clean --force -d -x
+    git reset --hard origin/main
+fi
+
+DRIVER_VERSION=$(git describe | sed s/^v//)
+
+# Build up Debian related variables required for packaging
+DEBIAN_ARCH=$(dpkg --print-architecture)
+DEBIAN_DIR="${CWD}/vyos-intel-${DRIVER_NAME}_${DRIVER_VERSION}_${DEBIAN_ARCH}"
+DEBIAN_CONTROL="${DEBIAN_DIR}/DEBIAN/control"
+DEBIAN_POSTINST="${CWD}/vyos-intel-${DRIVER_NAME}.postinst"
+
+# See https://vyos.dev/T6155
+# See https://vyos.dev/T6162
+PATCH_DIR=${CWD}/patches/${DRIVER_NAME}
+if [ -d $PATCH_DIR ]; then
+    for patch in $(ls ${PATCH_DIR})
+    do
+        echo "I: Apply patch: ${PATCH_DIR}/${patch}"
+        patch -p1 < ${PATCH_DIR}/${patch}
+    done
+fi
+
+echo "I: Compile Kernel module for Intel ${DRIVER_NAME} driver"
+make KSRC=${KERNEL_DIR} INSTALL_MOD_PATH=${DEBIAN_DIR} INSTALL_FW_PATH=${DEBIAN_DIR} -j $(getconf _NPROCESSORS_ONLN) -C src install
+
+if [ "x$?" != "x0" ]; then
+    exit 1
+fi
+
+if [ -f ${DEBIAN_DIR}.deb ]; then
+    rm ${DEBIAN_DIR}.deb
+fi
+
+# build Debian package
+echo "I: Building Debian package vyos-intel-${DRIVER_NAME}"
+cd ${CWD}
+
+# Sign generated Kernel modules
+${CWD}/sign-modules.sh ${DEBIAN_DIR}
+
+# delete non required files which are also present in the kernel package
+# und thus lead to duplicated files
+find ${DEBIAN_DIR} -name "modules.*" | xargs rm -f
+
+echo "#!/bin/sh" > ${DEBIAN_POSTINST}
+echo "/sbin/depmod -a ${KERNEL_VERSION}${KERNEL_SUFFIX}" >> ${DEBIAN_POSTINST}
+
+fpm --input-type dir --output-type deb --name vyos-intel-${DRIVER_NAME} \
+    --version ${DRIVER_VERSION} --deb-compression gz \
+    --maintainer "VyOS Package Maintainers <maintainers@vyos.net>" \
+    --description "Vendor based driver for Intel ${DRIVER_NAME}" \
+    --depends linux-image-${KERNEL_VERSION}${KERNEL_SUFFIX} \
+    --license "GPL2" -C ${DEBIAN_DIR} --after-install ${DEBIAN_POSTINST}
diff --git a/scripts/package-build/linux-kernel/build.py b/scripts/package-build/linux-kernel/build.py
index a1b7e3e5..6a43fc25 100755
--- a/scripts/package-build/linux-kernel/build.py
+++ b/scripts/package-build/linux-kernel/build.py
@@ -131,10 +131,12 @@ def build_package(package: dict, dependencies: list) -> None:
             create_tarball(f'{package["name"]}-{package["commit_id"]}', f'{package["name"]}')
         elif package['build_cmd'] == 'build_intel_qat':
             build_intel_qat()
+        elif package['build_cmd'] == 'build_intel_igb':
+            build_intel(package['name'], package['commit_id'], package['scm_url'])
         elif package['build_cmd'] == 'build_intel_ixgbe':
-            build_intel_ixgbe(package['commit_id'], package['scm_url'])
+            build_intel(package['name'], package['commit_id'], package['scm_url'])
         elif package['build_cmd'] == 'build_intel_ixgbevf':
-            build_intel_ixgbevf()
+            build_intel(package['name'], package['commit_id'], package['scm_url'])
         elif package['build_cmd'] == 'build_mellanox_ofed':
             build_mellanox_ofed()
         elif package['build_cmd'] == 'build_realtek_r8152':
@@ -215,16 +217,11 @@ def build_intel_qat():
     run(['./build-intel-qat.sh'], check=True)
 
 
-def build_intel_ixgbe(commit_id, scm_url):
-    """Build Intel IXGBE"""
-    repo_dir = Path('ethernet-linux-ixgbe')
+def build_intel(driver_name: str, commit_id: str, scm_url: str):
+    """Build Intel driver from Git repository"""
+    repo_dir = Path(f'ethernet-linux-{driver_name}')
     clone_or_update_repo(repo_dir, scm_url, commit_id)
-    run(['./build-intel-ixgbe.sh'], check=True)
-
-
-def build_intel_ixgbevf():
-    """Build Intel IXGBEVF"""
-    run(['./build-intel-ixgbevf.sh'], check=True)
+    run(['./build-intel-nic.sh', driver_name], check=True)
 
 
 def build_mellanox_ofed():
diff --git a/scripts/package-build/linux-kernel/package.toml b/scripts/package-build/linux-kernel/package.toml
index c407ab91..2d80fdfe 100644
--- a/scripts/package-build/linux-kernel/package.toml
+++ b/scripts/package-build/linux-kernel/package.toml
@@ -42,6 +42,12 @@ commit_id = ""
 scm_url = ""
 build_cmd = "build_intel_qat"
 
+[[packages]]
+name = "igb"
+commit_id = "v5.18.7"
+scm_url = "https://github.com/intel/ethernet-linux-igb"
+build_cmd = "build_intel_igb"
+
 [[packages]]
 name = "ixgbe"
 commit_id = "v6.0.5"
@@ -50,8 +56,8 @@ build_cmd = "build_intel_ixgbe"
 
 [[packages]]
 name = "ixgbevf"
-commit_id = ""
-scm_url = ""
+commit_id = "v5.0.2"
+scm_url = "http://github.com/intel/ethernet-linux-ixgbevf"
 build_cmd = "build_intel_ixgbevf"
 
 [[packages]]
-- 
cgit v1.2.3