/jetson-orin-kernel-builder

Build the Linux kernel and modules on board the Jetson AGX Orin, Orin Nano or Orin NX

Primary LanguageShellMIT LicenseMIT

jetson-orin-kernel-builder

Tools to build the Linux kernel and modules on board the Jetson AGX Orin, Orin Nano, or Orin NX. This tool is designed for beginning to intermediate users. Please read this entire document before proceeding.

This is for JetPack 6. Supporting video. on YouTube.

Overview

This repository contains convenience scripts to simplify the process of:

  • Downloading Kernel and Module Sources (Board Support Package Sources - BSP)
  • Editing Kernel Configuration (Both GUI and CLI options available)
  • Building the Kernel Image
  • Building Kernel Modules (in-tree (tested) and out of tree (untested) )

These scripts help automate common tasks involved in kernel modification and module development on Jetson Linux 36.X.

Prerequisites

Before using these scripts, ensure:

  • You have a Jetson Orin device running JetPack 6.X.
  • Your system is up to date: 
    sudo apt update && sudo apt upgrade -y

Scripts

1. Get Kernel and Module Sources

get_kernel_sources.sh

Downloads, extracts, and configures the kernel source for Jetson Linux 36.X.

  • Automatically detects L4T version.
  • Supports backing up or replacing existing kernel sources.
  • Extracts kernel, out-of-tree modules, and display driver sources.
  • Copies the current kernel config as basis for modification.

Usage:

./scripts/get_kernel_sources.sh [--force-replace] [--force-backup]

Options:

  • --force-replace → Delete existing kernel sources and downloads fresh sources.
  • --force-backup → Backup existing kernel sources before downloading new ones.

2. Edit Kernel Configuration

GUI Mode: edit_config_gui.sh

Launches make xconfig, a graphical interface for kernel configuration.

  • Checks for required Qt5 libraries and installs them if missing.
  • Runs make xconfig with appropriate permissions.

Usage:

./scripts/edit_config_gui.sh [kernel_source_directory]

Defaults to /usr/src/kernel/kernel-jammy-src.

CLI Mode: edit_config_cli.sh

Launches make menuconfig, a text-based interface for kernel configuration.

  • Checks for ncurses dependency (libncurses5-dev).
  • Runs 'make menuconfig' with appropriate permissions

Usage:

./scripts/edit_config_cli.sh [[-d directory] | [-h]]

Options:

  • -d | --directory <path> → Specify kernel source directory.
  • -h | --help → Display help message.

3. Build the Kernel

make_kernel.sh

Compiles the Linux kernel for the Jetson Orin series.

  • Checks kernel source path.
  • Removes old kernel images to ensure a clean build.
  • Uses multiple CPU cores to optimize compilation.
  • Retries with a single-threaded build if necessary.

Usage:

./scripts/make_kernel.sh [[-d directory] | [-h]]

Options:

  • -d | --directory <path> → Specify kernel source directory.
  • -h | --help → Display help message.

4. Build Kernel Modules

make_kernel_modules.sh

Builds and optionally installs kernel modules.

  • Uses optimized CPU allocation for faster compilation.
  • Automatically updates module dependencies after installation.
  • If installation is skipped, provides manual install instructions.

Usage:

./scripts/make_kernel_modules.sh [[-d directory] | [-h]]

Options:

  • -d | --directory <path> → Specify kernel source directory.
  • -h | --help → Display help message.

Query Tool

This script analyzes kernel module flags, their dependencies, and configuration types for the NVIDIA Jetson Developer Kit. It helps users understand module flags, their status, dependencies, and related configurations by searching through Makefiles, Kconfig, and .config. The script also supports searching for related strings within kernel configuration files.

Usage:

./scripts/module_info.sh [-h] [-s <search_string>] <module_flag>

Options:

  • -h : Display help message.
  • -s <search_string> : Search for a string in Makefiles, Kconfig, and .config (case-insensitive).

Examples: Analyze a specific config flag:

./scripts/module_info.sh CONFIG_LOGITECH_FF

Analyze a config module:

./scripts/module_info.sh CONFIG_USB_SERIAL_CH341

Search for USB-related configurations:

./scripts/module_info.sh -s usb

Features:

  • Extracts module and flag information, including its type, possible values, and dependencies.
  • Checks if the module is built-in (y), a loadable module (m), or not set (n).
  • Supports searching for related configuration strings across kernel sources.

Environment Variables:

  • KERNEL_URI : Specifies the kernel source directory (default: /usr/src/kernel/kernel-jammy-src).

Pre-built module

The prebuilt directory contains pre-compiled linux kernel modules, mostly sourced from the mainline Linux kernel. They are offered as a convenience binary for systems where this in-tree module is not included or enable by default.

Release History

March 2025

  • Initial Release
  • Tested on JetPack 6.2
  • Tested on the following devices:
    • Jetson Orin Nano
    • Jetson AGX Orin

Notes

  • Ensure that all kernel changes are backed up before installing a new kernel or modules.
  • Running kernel modifications requires root privileges.
  • If you face issues, check the log files generated in the logs/ directory.