Skip to content

README.md

Latest commit

 

History

History
228 lines (146 loc) · 5.64 KB

README.md

File metadata and controls

228 lines (146 loc) · 5.64 KB

AI Kernel Driver Instructions

These instructions will guide you through compiling, installing, and managing the ai_kernel_driver kernel module. You will also learn how to load and unload the driver, as well as how to clean up build artifacts.

Table of Contents

  1. Prerequisites
  2. Step 1: Compile the Kernel Module
  3. Step 2: Install (Load) the Kernel Module
  4. Step 3: Verify the Module Installation
  5. Step 4: Interact with the Device Node
  6. Step 5: Uninstall (Unload) the Kernel Module
  7. Step 6: Clean Build Artifacts
  8. Testing

Prerequisites

  • Linux Environment: A Linux distribution with kernel headers installed.

  • Root or Sudo Access: Required for installing and removing kernel modules.

  • Kernel Headers: Ensure kernel headers matching your current kernel version are installed.

  • Basic Knowledge: Familiarity with compiling kernel modules and using make.

  • Installation of gcc-12: Make sure gcc-12 is installed. You can install it by running:

    • For Ubuntu/Debian:

      sudo apt update
sudo apt install gcc-12 g++-12

    • For Fedora/RHEL:

      sudo dnf install gcc-12 g++-12

    Verify the installation:

    gcc --version

  • Installation of make: Ensure make is installed, which is required for building kernel modules. Install it using:

    • For Ubuntu/Debian:

      sudo apt install build-essential

    • For Fedora/RHEL:

      sudo dnf groupinstall "Development Tools"

    Verify the installation:

    make --version

  • Code modification for newer kernels: If you are using a newer version of the Linux kernel, you need to modify the class_create function call in your code:

    • Original code (causing the error):

      ai_dev.class = class_create(THIS_MODULE, CLASS_NAME);

    • Updated code (for newer kernel versions):

      ai_dev.class = class_create(CLASS_NAME);

    You can check your kernel version by running:

    uname -r

Step 1: Compile the Kernel Module

  1. Open a terminal in the directory containing ai_kernel_driver.c, Makefile, and manage_ai_kernel_driver.sh.

  2. Ensure that the Makefile is correctly configured.

  3. Compile the kernel module using the provided make command:

    make
    • This command will invoke the kernel build system to compile the module.

  4. If the compilation is successful, an object file ai_kernel_driver.ko will be created.

Step 2: Install (Load) the Kernel Module

  1. Ensure the manage_ai_kernel_driver.sh script is executable:

    chmod +x manage_ai_kernel_driver.sh

  2. Use the script to install the module:

    sudo ./manage_ai_kernel_driver.sh install

    • This script will:

      • Build the module (if not already built).
      • Insert the module into the kernel using insmod.
      • Create the device node /dev/ai_driver.

  3. If prompted, enter your password for sudo privileges.

Step 3: Verify the Module Installation

  1. Check if the Module is Loaded:

    lsmod | grep ai_kernel_driver
    • This should display a line indicating that ai_kernel_driver is loaded.

  2. Check for Device Node:

    ls -l /dev/ai_driver
    • Ensure that the device node /dev/ai_driver exists with appropriate permissions.

  3. View Kernel Messages:

    dmesg | tail -n 20
    • Check the kernel messages for any errors or confirmation messages related to the driver.

Step 4: Interact with the Device Node

You can now interact with the device node /dev/ai_driver using standard file operations or through a test application.

  1. Read from the Device:

    cat /dev/ai_driver

  2. Write to the Device:

    echo "Test Data" | sudo tee /dev/ai_driver

  3. Use the Test Application:

    • If you have a user-space application (e.g., ai_driver_test) that interacts with the driver, you can run it now.
    sudo ./ai_driver_test

Step 5: Uninstall (Unload) the Kernel Module

  1. Use the manage_ai_kernel_driver.sh script to remove the module:

    sudo ./manage_ai_kernel_driver.sh uninstall

    • This script will:

      • Remove the device node /dev/ai_driver.
      • Unload the kernel module using rmmod.

  2. Verify the Module is Unloaded:

    lsmod | grep ai_kernel_driver
    • The module should no longer be listed.

Step 6: Clean Build Artifacts

  1. To clean up the build artifacts, run:

    make clean

  2. This will remove files generated during the build process.

Testing

  • System Stability: Loading kernel modules can affect system stability. Ensure you understand the code before installing.

  • Kernel Version Compatibility: The module should be compiled against the headers of your currently running kernel.

  • Permissions: Running commands with sudo privileges can have significant effects on your system. Use with caution.

  • Error Handling: Check dmesg for any error messages if something doesn't work as expected.

  • Modify NUM_THREADS: If applicable, adjust the number of threads in your test application based on your CPU cores.

  • Dependencies: Ensure all dependencies and kernel headers are installed before compiling the module.