Skip to content

docs: add external kernel module build steps - #2138

Open
tzz-radxa wants to merge 1 commit into
radxa-docs:mainfrom
tzz-radxa:docs/kernel-module-build-20260921
Open

tzz-radxa wants to merge 1 commit into
radxa-docs:mainfrom
tzz-radxa:docs/kernel-module-build-20260921

Conversation

@tzz-radxa

Copy link
Copy Markdown
Contributor

Summary

  • Document the out-of-tree kernel module workflow for bsp.
  • Add both cross-compilation and board-native build commands.
  • Add the kernel/header version-matching and local-source preservation notes.

Source

This change comes from the confirmed support topic omt_19d5400daf8e5b93 on 2026-09-21, where a ROCK 5B+ user asked how to compile a custom driver in the Docker/bsp environment.

The existing kernel page explained how to build and install the kernel and headers, but did not show how to turn a driver source tree into a .ko module or how to build it against /lib/modules/$(uname -r)/build. That omission made the supported workflow difficult to discover.

Checks

  • git diff --check
  • pre-commit run --files docs/common/dev/_kernel.mdx i18n/en/docusaurus-plugin-content-docs/current/common/dev/_kernel.mdx
  • python3 scripts/github_pr_guard.py check --repo-path <worktree> --fetch

@tzz-radxa
tzz-radxa requested a review from a team as a code owner September 21, 2026 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant