Skip to content

Commit e5cc751

Browse files
gooishingooishin
committed
docs: update missing information on the documentation (#974)
1 parent f259bb7 commit e5cc751

6 files changed

Lines changed: 43 additions & 114 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This repository provides simplified developer kit reference setup scripts for va
99

1010
> **Note:** The main branch contains the latest development version of the project. It may include experimental features, work in progress, or unstable code.
1111
12-
- Officially Supported: Ubuntu 24.04 LTS (tested on `Ubuntu 24.04.3 LTS`) with the 6.14 HWE kernel (for example `6.14.0-33-generic`).
12+
- Officially Supported: Ubuntu 24.04 LTS (tested on `Ubuntu 24.04.4 LTS`) with the 6.17 kernel.
1313
- Kernel / HWE Guidance: The setup and reference scripts are validated against the Ubuntu 24.04 HWE stack (Linux 6.14). We recommend using the HWE kernel matching the tested version for best compatibility and to avoid driver/packaging mismatches.
1414

1515
## Who Is This For?

‎main_installer.sh‎

Lines changed: 11 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -168,99 +168,23 @@ verify_ubuntu_24() {
168168
exit 1
169169
fi
170170

171-
# Kernel policy: Accept 6.14.x (standard) OR 6.17.x (OEM) when PTL_PLATFORM=true
171+
# Kernel policy: Accept 6.17
172172
local kernel_major kernel_minor running_kernel
173173
running_kernel=$(uname -r)
174174
kernel_major=$(echo "$running_kernel" | cut -d'.' -f1)
175175
kernel_minor=$(echo "$running_kernel" | cut -d'.' -f2)
176176

177-
if { [ "$kernel_major" = "6" ] && [ "$kernel_minor" = "14" ]; }; then
177+
if { [ "$kernel_major" = "6" ] && [ "$kernel_minor" = "17" ]; }; then
178178
echo "$S_VALID Ubuntu 24.04 LTS with supported HWE kernel $running_kernel detected"
179-
elif { [ "${PTL_PLATFORM:-false}" = true ] && [ "$kernel_major" = "6" ] && [ "$kernel_minor" = "17" ]; }; then
180-
echo "$S_VALID PTL platform OEM kernel $running_kernel accepted"
181179
else
182180
echo "$S_WARNING Unsupported kernel version: $running_kernel"
183-
if [ "${PTL_PLATFORM:-false}" = true ]; then
184-
echo "PTL platform detected; proceeding to install OEM 6.17 kernel via prerequisites phase."
185-
# Do not exit; apply_ptl_platform_prereqs will manage kernel upgrade & reboot gate.
186-
else
187-
echo "Currently only PTL platform validated with 6.17.x kernel version. For non-PTL platforms, 6.14.x is validated kernel version."
188-
if { [ "$kernel_major" = "6" ] && [ "$kernel_minor" -lt "14" ]; }; then
189-
# If kernel is older than 6.14
190-
echo "System kernel version is lower than 6.14.x, proceed upgrade to 6.14.x"
191-
apt update && apt install -y linux-image-6.14.0-37-generic \
192-
linux-modules-6.14.0-37-generic \
193-
linux-modules-extra-6.14.0-37-generic \
194-
linux-headers-6.14.0-37-generic
195-
echo "$S_VALID HWE kernel installed. Please reboot and run this installer again."
196-
exit 0
197-
else
198-
# If kernel is newer than 6.14 but not PTL
199-
echo "Kernel newer than 6.14.x are not validated. You may proceed at your own risk by manually install ./gpu_installer.sh and ./npu_installer.sh scripts."
200-
exit 0
201-
fi
202-
fi
203-
fi
204-
}
205-
206-
# Apply PTL platform prerequisites before standard GPU driver installation
207-
apply_ptl_platform_prereqs() {
208-
echo "# Applying PTL platform prerequisites..."
209-
210-
# 1. Install OEM 6.17 kernel (24.04d stream)
211-
echo "Checking available OEM kernel packages (linux-image-oem-24.04d / linux-headers-oem-24.04d)"
212-
apt-get update
213-
if ! dpkg -l | grep -q 'linux-image-oem-24.04d'; then
214-
echo "Installing OEM 6.17 kernel packages..."
215-
apt-get install -y linux-image-oem-24.04d linux-headers-oem-24.04d || {
216-
echo "$S_ERROR Failed to install OEM kernel packages"; exit 1; }
217-
else
218-
echo "$S_VALID OEM kernel already installed"
219-
fi
220-
221-
# 2. Add Kisak Mesa PPA for updated Mesa stack
222-
if ! grep -R "kisak-mesa" /etc/apt/sources.list /etc/apt/sources.list.d 2>/dev/null | grep -q kisak; then
223-
echo "Adding Kisak Mesa PPA..."
224-
apt-get install -y software-properties-common
225-
add-apt-repository -y ppa:kisak/kisak-mesa || { echo "$S_ERROR Failed to add Kisak Mesa PPA"; exit 1; }
226-
else
227-
echo "$S_VALID Kisak Mesa PPA already configured"
228-
fi
229-
230-
# 3. Update & upgrade packages
231-
echo "Updating and upgrading packages (this may take a while)..."
232-
apt-get update
233-
DEBIAN_FRONTEND=noninteractive apt-get -y upgrade || echo "$S_WARNING Some packages failed to upgrade"
234-
235-
# 4. Reinstall Xorg core (requested workaround)
236-
echo "Reinstalling xserver-xorg-core..."
237-
apt-get install -y --reinstall xserver-xorg-core || echo "$S_WARNING Failed to reinstall xserver-xorg-core"
238-
239-
# 5. Configure any pending dpkg states & fix broken packages
240-
dpkg --configure -a || echo "$S_WARNING dpkg configure reported issues"
241-
apt-get -y --fix-broken install || echo "$S_WARNING fix-broken reported issues"
242-
243-
# Reboot gate: if running kernel not yet 6.17 after install, instruct reboot & exit early
244-
local running_kernel new_kernel_info
245-
running_kernel=$(uname -r)
246-
new_kernel_info=$(dpkg -l | grep '^ii' | grep 'linux-image-oem-24.04d' | awk '{print $2"="$3}' || true)
247-
if ! echo "$running_kernel" | grep -q '^6\.17'; then
248-
# Install GPU drivers before reboot
249-
# shellcheck disable=SC1091
250-
GPU_INSTALLER_NO_MAIN=1 source "${SCRIPT_DIR}/gpu_installer.sh"
251-
apply_xe_ptl_fix
252-
remove_conflicting_packages
253-
configure_kobuk_repository
254-
install_packages "${DEPENDENCIES[@]}"
255-
install_packages "${COMMON_GPU_PACKAGES[@]}"
256-
install_packages "${MEDIA_GPU_PACKAGES[@]}"
257-
258-
echo "$S_WARNING Running kernel ($running_kernel) differs from installed OEM 6.17 kernel ($new_kernel_info)."
259-
echo "Please reboot and run this installer again."
260-
echo "$S_VALID PTL stage 1 complete (kernel + mesa). Exiting early."
181+
echo "Updating kernel to 6.17"
182+
apt update && apt install -y linux-image-6.17.0-19-generic \
183+
linux-modules-6.17.0-19-generic \
184+
linux-modules-extra-6.17.0-19-generic \
185+
linux-headers-6.17.0-19-generic
186+
echo "$S_VALID HWE kernel installed. Please reboot and run this installer again."
261187
exit 0
262-
else
263-
echo "$S_VALID PTL platform prerequisites applied; OEM kernel already active ($running_kernel)."
264188
fi
265189
}
266190

@@ -491,22 +415,6 @@ detect_platform() {
491415

492416
echo " CPU Model: $CPU_MODEL"
493417
echo " Platform Family: $PLATFORM_FAMILY"
494-
495-
# PTL platform detection:
496-
# Matches Intel Core Ultra 3xx U/P/H SKUs (e.g. 325U, 355H, 385P, 358H)
497-
# Regex explanation:
498-
# Intel(R) Core(TM) Ultra ... space + '3' + two digits + one of U/P/H
499-
local ptl_regex='Intel\(R\) Core\(TM\) Ultra .* 3[0-9]{2}[UPH]'
500-
PTL_PLATFORM=false
501-
if echo "$CPU_MODEL" | grep -Eq "$ptl_regex"; then
502-
PTL_PLATFORM=true
503-
echo "$S_VALID PTL platform detected"
504-
else
505-
if [ "$IS_COREULTRA" = true ]; then
506-
echo "$S_WARNING Core Ultra platform (non-PTL SKU)"
507-
fi
508-
fi
509-
export PTL_PLATFORM
510418
}
511419

512420
# Check if Core Ultra platform
@@ -610,16 +518,8 @@ main() {
610518
# 3. Install essential development tools
611519
install_build_essentials
612520
echo ""
613-
614-
# 4. Apply PTL prerequisites only if PTL platform and not already on 6.17
615-
if [ "${PTL_PLATFORM}" = true ] && ! uname -r | grep -q '^6\.17'; then
616-
echo "# PTL platform prerequisites detected (kernel upgrade path) ..."
617-
apply_ptl_platform_prereqs
618-
# Function may exit early; if it doesn't, continue with flow
619-
echo ""
620-
fi
621521

622-
# 5. Platform Installation Flow
522+
# 4. Platform Installation Flow
623523
echo "# Platform Installation Flow..."
624524
echo "$S_VALID Platform detected: $CPU_MODEL"
625525

@@ -647,7 +547,7 @@ main() {
647547
fi
648548

649549
else
650-
# Any platform that is not PTL
550+
# Any platform that is not coreultra
651551
echo ""
652552
echo "========================================================================"
653553
echo "# STANDARD INTEL PLATFORM INSTALLATION"
@@ -675,6 +575,7 @@ main() {
675575
echo "========================================================================"
676576
echo "Installation completed: $(date '+%Y-%m-%d %H:%M:%S')"
677577
echo "Log file saved: $LOG_FILE"
578+
echo "Installation completed. Please reboot the system to ensure all changes take effect"
678579
echo "========================================================================"
679580
}
680581

‎npu_installer.sh‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ NPU_VERSION="${NPU_VERSION:-}"
2222
NPU_BUILD_ID="${NPU_BUILD_ID:-}"
2323
NPU_ASSET_URL="${NPU_ASSET_URL:-}"
2424

25+
log_success() {
26+
echo "$S_VALID $1"
27+
}
28+
2529
# Resolve latest release and asset URL from GitHub (no jq required)
2630
resolve_latest_release() {
2731
local json url tag asset_name

‎usecases/camera/gmsl/ECI-README.md‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,21 @@ This script provides automated setup for Intel IPU6 DKMS drivers, ECI repositori
1111
## Table of Contents
1212

1313
- [System Requirements](#system-requirements)
14+
- [Operating System](#operating-system)
15+
- [Hardware Requirements](#hardware-requirements)
16+
- [Software Dependencies](#software-dependencies)
17+
- [Supported Hardware IDs](#supported-hardware-ids)
18+
- [Network Requirements](#network-requirements)
19+
- [Validated Hardware](#validated-hardware)
1420
- [Hardware Setup and Connections](#hardware-setup-and-connections)
21+
- [Connection Steps](#connection-steps)
1522
- [BIOS Configurations](#bios-configurations)
1623
- [Quick Start Guide](#quick-start-guide)
24+
- [Prerequisites](#prerequisites)
25+
- [Installation Steps](#installation-steps)
26+
- [Post-Installation Verification](#post-installation-verification)
1727
- [Usage](#usage)
18-
- [Script Execution Modes](#script-execution-modes)
19-
- [Cleanup and Reset](#cleanup-and-reset)
28+
- [Script Execution Modes](#script-execution-modes)
2029
- [Support and Documentation](#support-and-documentation)
2130
- [Disclaimer](#disclaimer)
2231

@@ -49,6 +58,13 @@ This script provides automated setup for Intel IPU6 DKMS drivers, ECI repositori
4958
- Access to `packages.ros.org` for ROS packages
5059
- Access to `raw.githubusercontent.com` for GPG keys
5160

61+
### Validated Hardware
62+
63+
| Product Collection | Camera |Validated Hardware |
64+
|---|---|---|
65+
| 12th/13th/14th Gen Intel® Core™ | RealSense™ Depth Camera D457, D3 Embedded® (ISX031, IMX390), oToBrite® (ISX031, ISX021) |Axiomtek* ROBOX500 |
66+
| Intel® Core™ Ultra Series 1 and 2 | RealSense™ Depth Camera D457, D3 Embedded® (ISX031, IMX390), oToBrite® (ISX031, ISX021) | SEAVO* Embedded Computer HB03, Advantech* AFE-R360 series, ASR-A502 series with Advantech* GMSL Input Module Card |
67+
5268
## Hardware Setup and Connections
5369

5470
### Connection Steps

‎usecases/camera/gmsl/QUICK_START_GUIDE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# IPU7 GMSL Camera Quick Start Guide (Draft)
1+
# IPU7 GMSL Camera Quick Start Guide
22

33
## 1. Introduction
44

‎usecases/camera/mipi/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ This directory contains scripts for setting up Intel IPU6 camera support on Ubun
1010
- Internet connection for downloading packages
1111
- IPU6 userspace package (ARL-UH_IPU_FW_HDMI-in.zip) from Intel
1212

13+
## Validated System
14+
15+
The exact validated matrix can change across kernel, firmware, and camera/AIC revisions. Use this section as reference.
16+
17+
| Product Collection | Codename | Camera | Support | Validated Hardware |
18+
|---------|--------|---------|--------|---------|
19+
| Intel® Core™ Ultra Processors (Series 2) | Products formerly Arrow Lake | 2 x D3 - AR0234 | ✅ Supported | Innodisk Intel® Core™ Ultra Series 2 Reference Kit |
20+
1321
## Quick Start
1422

1523
1. **Download the IPU6 userspace package** from Intel:

0 commit comments

Comments
 (0)