dkms procedure for akida-pcie-1.0

[torehl]

.

[torehl]

Akida PCIe Driver DKMS Installation Procedure

This guide explains how to install the akida-pcie driver using DKMS (Dynamic Kernel Module Support).
Using DKMS ensures that the driver is automatically rebuilt and reinstalled whenever you update your Linux kernel.

Prerequisites

Make sure you have DKMS and the required build tools installed:

sudo apt install dkms build-essential linux-headers-$(uname -r)
sudo git clone https://github.com/Brainchip-Inc/akida_dw_edma /usr/src/akida-pcie-1.0

Step 1: Create DKMS Configuration

Run the following command in the driver directory to create the dkms.conf file:

sudo cat << 'EOF' >  /usr/src/akida-pcie-1.0/dkms.conf
PACKAGE_NAME="akida-pcie"
PACKAGE_VERSION="1.0"
MAKE="'make' KERNEL_VERSION=${kernelver} all"
CLEAN="'make' clean"
BUILT_MODULE_NAME[0]="akida-pcie"
DEST_MODULE_LOCATION[0]="/updates"
AUTOINSTALL="yes"
POST_INSTALL="post_install.sh"
EOF

Step 2: Create Post-Install Script

To ensure udev rules are properly copied and loaded automatically upon installation, create the post_install.sh script and make it executable:

sudo cat << 'EOF' >  /usr/src/akida-pcie-1.0/post_install.sh
#!/bin/sh
# Copy udev rules
cp 99-akida-pcie.rules /etc/udev/rules.d/ || true

# Reload and trigger udev rules so the device node permissions update immediately
udevadm control --reload-rules || true
udevadm trigger || true
EOF

sudo chmod +x /usr/src/akida-pcie-1.0/post_install.sh

Step 3: Register and Install with DKMS

Now, instruct DKMS to add, build, and install the module.

# Add the module to DKMS tree
sudo dkms add -m akida-pcie -v 1.0

# Build the module
sudo dkms build -m akida-pcie -v 1.0

# Install the module
sudo dkms install -m akida-pcie -v 1.0

Step 4: Verify Installation

To verify that the module was installed and loaded correctly, you can use:

sudo dkms status
sudo lsmod | grep akida

If you don't see it loaded, you might need to trigger loading manually the first time or check if your system needs a reboot:

sudo modprobe akida-pcie

Uninstallation

If you ever need to remove the DKMS module from your system, run:

sudo dkms remove -m akida-pcie -v 1.0 --all
sudo rm -rf /usr/src/akida-pcie-1.0