# ark-electronics/ark_jetson_kernel architecture

> Architecture diagram of the GitHub repository ark-electronics/ark_jetson_kernel, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ark-electronics/ark_jetson_kernel
- Repository: https://github.com/ark-electronics/ark_jetson_kernel

## Overview

##### Project Type and Purpose
- This is an open-source toolset and automation framework for flashing and configuring NVIDIA Jetson Orin Nano/NX modules on an ARK Jetson Carrier board.
- The README confirms the repository contains host-side scripts (setup, build, flash, network configuration) plus device-tree overlays for two carrier variants (ark_jaj, ark_pab), facilitating kernel builds, DTB generation, and final image flashing.

##### File-Structure Analysis
Top-level:
- setup.sh, build_kernel.sh, flash.sh, copy_dtbs_to_prebuilt.sh, copy_camera_params_to_prebuilt.sh – orchestration scripts
- add_wifi_network.sh, share_wifi.sh, stop_share_wifi.sh – network configuration scripts
- device_tree/ark_jaj, device_tree/ark_pab – DTS/overlay files for each board variant
- ConnectionTemplate.nmconnection, .gitignore – host config files

Patterns:
- “device_tree” sub-dirs contain overlays applied during kernel build
- Scripts reference a source_build/Linux_for_Tegra workspace and a prebuilt/Linux_for_Tegra workspace
- Cross-compile toolchain (aarch64 buildroot) and L4T kernel sources are invoked by build_kernel.sh

##### Key Insights from README
- The flow:
a. setup.sh downloads/builds JetPack 6 sources, configures user
b. build_kernel.sh cross-compiles kernel, modules, dtbs
c. copy_dtbs_to_prebuilt.sh installs new DTBs into prebuilt image
d. flash.sh uses NVIDIA flash tools (flash.sh or l4t_initrd_flash.sh) to write to QSPI and NVMe
e. Optional camera-overlay build & deploy without reflashing

a. Main Components
- Host PC (Ubuntu 22.04)
- Shell scripts orchestration layer (setup, build_kernel, flash, network)
- Cross-compile Toolchain (aarch64-buildroot GCC)
- Kernel Source Workspace (source_build/Linux_for_Tegra/source)
- Device-Tree Workspace (device_tree/ark_jaj & ark_pab)
- Prebuilt Image Workspace (prebuilt/Linux_for_Tegra)
- External ARK-OS git repository (optional post-flash)
- Physical Connections
- USB-A to Micro-USB: recovery & network console
- NVMe storage on Jetson board
- Target Device: Jetson Orin Nano/NX module
- On-board QSPI bootloader
- Internal NVMe rootfs
- Device-tree overlays for carrier board and cameras

b. Relationships & Data Flow
1. Host PC runs setup.sh → fetches JetPack sources into source_build
2. build_kernel.sh + device_tree overlays → invokes CROSS_COMPILE → produce kernel Image, modules, dtbs
3. copy_dtbs_to_prebuilt.sh & copy_camera_params_to_prebuilt.sh → synchronize artifacts into prebuilt workspace
4. flash.sh (or l4t_initrd_flash.sh) → uses prebuilt/Linux_for_Tegra tools → streams bootloader/kernel/ramdisk over USB to Jetson in recovery
5. Jetson boots from QSPI (bootloader) → NVMe rootfs → configured kernel + device trees
6. Optional: scp camera-overlay DTBs to running Jetson → /boot → apply via jetson-io

c. Architectural Patterns
- Layered pipeline:
Host scripts → build env → artifacts → flashing tool → target device
- Overlay pattern: device-tree source + overlay directories → merged at build time
- Separation of concerns:
- “source_build” for compiling
- “prebuilt” for staging images and flashing
- “device_tree” purely for hardware configuration

d. Technologies & Frameworks
- NVIDIA L4T / JetPack 6 kernel sources
- aarch64-buildroot cross-compiler
- bash shell scripting
- NVIDIA flash tools (flash.sh, l4t_initrd_flash.sh)
- GStreamer for camera testing
- Jetson-IO for runtime overlay application

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Host Environment
    subgraph "Host Environment"
        Host["Host PC\n(Ubuntu 22.04)"]:::host
        Setup["setup.sh\n(download & configure)"]:::script
        BuildKernel["build_kernel.sh\n(cross-compile)"]:::script
        CopyDTB["copy_dtbs_to_prebuilt.sh\n(DTB sync)"]:::script
        CopyCam["copy_camera_params_to_prebuilt.sh\n(Camera params sync)"]:::script
        FlashScript["flash.sh\n(flash tool)"]:::script
        AddWiFi["add_wifi_network.sh"]:::script
        ShareWiFi["share_wifi.sh"]:::script
        StopWiFi["stop_share_wifi.sh"]:::script
        Template["ConnectionTemplate.nmconnection"]:::config
        README["README.md"]:::doc
    end

    %% Workspaces & Artifacts
    subgraph "Workspaces & Artifacts"
        Toolchain["Cross-compile Toolchain\n(aarch64-buildroot)"]:::toolchain
        SourceBuild(("source_build/Linux_for_Tegra")):::storage
        subgraph "Device-Tree Overlays"
            JAJ["ark_jaj"]:::overlay
            PAB["ark_pab"]:::overlay
        end
        Prebuilt(("prebuilt/Linux_for_Tegra")):::storage
    end

    %% Target Hardware
    subgraph "Target Hardware"
        Bootloader["QSPI Bootloader"]:::device
        NVMe["NVMe Storage\n(rootfs)"]:::device
        Jetson["Jetson Orin Nano/NX"]:::device
    end

    %% Data Flows
    Host --> Setup
    Setup --> SourceBuild
    Host --> BuildKernel
    Toolchain --> BuildKernel
    SourceBuild --> BuildKernel
    JAJ --> BuildKernel
    PAB --> BuildKernel
    BuildKernel --> Prebuilt
    CopyDTB --> Prebuilt
    CopyCam --> Prebuilt
    Prebuilt --> FlashScript
    FlashScript --> Jetson
    Jetson --> Bootloader
    Jetson --> NVMe

    %% Optional Flows
    CopyCam -->|scp camera-overlay| Jetson
    AddWiFi -->|configure network| Jetson
    ShareWiFi --> Host
    StopWiFi --> Host

    %% Documentation link
    Host --> README

    %% Click Events
    click Setup "https://github.com/ark-electronics/ark_jetson_kernel/blob/main/setup.sh"
    click BuildKernel "https://github.com/ark-electronics/ark_jetson_kernel/blob/main/build_kernel.sh"
    click FlashScript "https://github.com/ark-electronics/ark_jetson_kernel/blob/main/flash.sh"
    click CopyDTB "https://github.com/ark-electronics/ark_jetson_kernel/blob/main/copy_dtbs_to_prebuilt.sh"
    click CopyCam "https://github.com/ark-electronics/ark_jetson_kernel/blob/main/copy_camera_params_to_prebuilt.sh"
    click AddWiFi "https://github.com/ark-electronics/ark_jetson_kernel/blob/main/add_wifi_network.sh"
    click ShareWiFi "https://github.com/ark-electronics/ark_jetson_kernel/blob/main/share_wifi.sh"
    click StopWiFi "https://github.com/ark-electronics/ark_jetson_kernel/blob/main/stop_share_wifi.sh"
    click JAJ "https://github.com/ark-electronics/ark_jetson_kernel/tree/main/device_tree/ark_jaj"
    click PAB "https://github.com/ark-electronics/ark_jetson_kernel/tree/main/device_tree/ark_pab"
    click Template "https://github.com/ark-electronics/ark_jetson_kernel/blob/main/ConnectionTemplate.nmconnection"
    click README "https://github.com/ark-electronics/ark_jetson_kernel/blob/main/README.md"

    %% Styles
    classDef host fill:#D0E8FF,stroke:#027BFF;
    classDef script fill:#E0F7FA,stroke:#00838F;
    classDef storage fill:#E8F5E9,stroke:#388E3C;
    classDef overlay fill:#C8E6C9,stroke:#2E7D32;
    classDef toolchain fill:#E8F5E9,stroke:#388E3C;
    classDef device fill:#FFF3E0,stroke:#F57C00;
    classDef config fill:#FFFDE7,stroke:#F9A825;
    classDef doc fill:#F3E5F5,stroke:#6A1B9A;
```
