# xdl-sdk

**Repository Path**: xdltek/xdl-sdk

## Basic Information

- **Project Name**: xdl-sdk
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-15
- **Last Updated**: 2026-07-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <img src="images/logo_color_horizontal.png" width="320" alt="XDL logo">
</p>

<h1 align="center">XDL SDK</h1>

语言：[中文](README.md) | [English](README_EN.md)

## 概述

XDL SDK 是 XDL 面向客户、合作伙伴和解决方案团队发布 SDK 的官方交付入口。
它为客户提供统一、可校验、可按平台自动选择的 SDK 获取和安装体验。

通过本仓库，用户可以完成 SDK 的下载、校验、安装、更新、卸载和版本查询。
工具会根据目标系统和 CPU 架构自动选择对应 SDK 安装包，从 XDL 官方发布源下载，
完成 MD5 校验后执行安装流程。

## 核心能力

- 统一安装入口：`install.sh`
- SDK 生命周期管理：`sdk_manager.sh`
- 通过 `sdk.json` 管理版本、平台、下载地址和 MD5
- 按 OS 和 CPU 架构自动选择 SDK 包
- 安装前执行环境和依赖检查
- 安装前执行 MD5 完整性校验
- 支持 install、update、uninstall、list、verify、version
- SDK 更新失败时支持回滚

## 快速开始

```bash
git clone https://github.com/xdltek/xdl-sdk.git
cd xdl-sdk
sudo bash install.sh
```

默认流程：

1. 检查 root 权限、网络、下载工具、磁盘空间、OS、架构和 SDK 安装依赖。
2. 读取 `sdk.json`。
3. 选择 `latest` SDK 版本。
4. 自动识别主机 OS 和 CPU 架构。
5. 下载匹配的 SDK `.run` 安装包。
6. 校验 MD5。
7. 执行 SDK 安装。
8. 缓存安装包，用于后续回滚。

## 仓库结构

```text
xdl-sdk/
|-- install.sh
|-- sdk_manager.sh
|-- sdk.json
|-- README.md
|-- README_EN.md
|-- LICENSE
|-- images/
|   |-- logo_color_horizontal.png
|-- scripts/
|   |-- check_env.sh
|   |-- download.sh
|   |-- get_version.sh
|   |-- json_query.py
|   |-- logger.sh
|   |-- uninstall.sh
|   |-- upgrade.sh
|   |-- utils.sh
|   |-- verify_md5.sh
|   |-- verify_run_file.sh
```

## 文件作用

| 文件 | 作用 |
| --- | --- |
| `install.sh` | 客户默认入口。先执行环境检查，再启动 SDK 安装。 |
| `sdk_manager.sh` | SDK 包管理器，负责安装、更新、卸载、列表、校验和版本查询。 |
| `sdk.json` | SDK 包索引，维护版本、OS/架构、下载地址、MD5 和 Release 信息。 |
| `README_EN.md` | 英文用户文档。 |
| `scripts/json_query.py` | `sdk_manager.sh` 内部使用的 JSON 解析工具，用户无需直接调用。 |
| `scripts/` | 内部辅助脚本，包括环境检查、下载、校验、日志和兼容入口。 |
| `LICENSE` | 仓库许可证。 |

## 常用命令

只有会修改主机系统的命令需要 root 权限：`install`、`update` 和 `uninstall`。
只读命令或仅下载校验的命令不需要 `sudo`，例如 `list`、`verify` 和 `version`。

安装最新 SDK：

```bash
sudo bash install.sh
```

使用包管理器安装：

```bash
sudo bash sdk_manager.sh install
```

安装指定版本：

```bash
sudo bash sdk_manager.sh install --version 1.6.7.2
```

跳过驱动构建/加载：

```bash
sudo bash sdk_manager.sh install --skip-drv
```

更新 SDK：

```bash
sudo bash sdk_manager.sh update
```

卸载 SDK：

```bash
sudo bash sdk_manager.sh uninstall
```

列出可下载 SDK：

```bash
bash sdk_manager.sh list
```

校验 SDK 包：

```bash
bash sdk_manager.sh verify --version 1.6.7.2
```

查看已安装 SDK 版本：

```bash
bash sdk_manager.sh version
```

## 支持平台

当前 `sdk.json` 支持：

| OS | 架构 | 包映射 |
| --- | --- | --- |
| Ubuntu | `x86_64`, `aarch64` | Debian SDK 包 |
| Debian | `x86_64`, `aarch64` | Debian SDK 包 |
| Kylin | `x86_64`, `aarch64` | Debian SDK 包 |
| openEuler | `x86_64` | openEuler SDK 包 |

自动识别不满足现场环境时，可手动指定：

```bash
sudo bash sdk_manager.sh install --os ubuntu --arch x86_64
```

## 平台要求

### 安装脚本要求

| 组件 | 要求 |
| --- | --- |
| Shell | Bash |
| Python | Python 3，推荐 Python 3.11 |
| 下载工具 | `wget` 或 `curl` |
| 校验工具 | `md5sum` |
| 权限 | install、update、uninstall 需要 root 权限 |

### Ubuntu

支持平台：

- x86_64 主机
- RK3588
- RK3568

最低要求：

| 组件 | 要求 |
| --- | --- |
| 操作系统 | Ubuntu 20.04 LTS 或兼容 Ubuntu 的发行版 |
| 系统内存 | 推荐 >= 16 GB DDR5 |
| CPU 架构 | x86_64 或 aarch64 |
| 编译器 | GCC 9.4.0 或兼容版本 |
| CMake | 推荐 >= 3.26.5 |
| Python | 推荐 Python 3.11 |
| 构建工具 | `build-essential`, `linux-headers`, `dkms`, `dctrl-tools` |

### Kylin

支持 CPU 平台：

- 海光
- 飞腾

已验证内核/编译器基线：

```text
Linux version 5.4.18-152-generic
GCC 9.4.0 (Ubuntu 9.4.0-1ubuntu1~20.04.1)
```

已验证 aarch64 内核基线：

```text
Linux version 6.6.0-58-generic #57-KYLINOS SMP Thu Dec 18 12:24:49 UTC 2025 aarch64
```

### openEuler

支持平台：

- x86_64 主机

已验证内核/编译器基线：

```text
Linux version 6.6.0-127.0.0.125.oe2403sp1.x86_64
GCC 12.3.1 (openEuler 12.3.1-65.oe2403sp1)
GNU Binutils 2.41
```

## SDK 包索引

SDK 包选择由 `sdk.json` 控制。后续新增版本时，应更新 `sdk.json`，
不要把下载地址写死在 Shell 脚本中。

## 故障处理

### 缺少前置依赖

SDK `.run` 安装包中包含 `rpp-dkms`。驱动安装依赖系统中的 `dkms`、
`cmake` 等软件包。缺少依赖时，`rpp-dkms` 可能停留在 `iU` 半安装状态，
并导致包管理器报告破损依赖。

`install.sh` 和 `sdk_manager.sh install/update` 会在执行 SDK 安装前检查这些依赖。
如果发现缺失，会打印安装命令并退出，不会继续修改 SDK 安装状态。

#### Debian / Ubuntu / Kylin

```bash
sudo apt update
sudo apt install -y cmake
sudo apt install -y dkms dctrl-tools build-essential linux-headers-$(uname -r)
```

确认：

```bash
dpkg -l dkms dctrl-tools | grep ^ii
dkms --version
cmake --version
```

如果此前因缺依赖导致 `rpp-dkms` 半安装：

```bash
sudo apt --fix-broken install -y
sudo dpkg --configure -a
```

#### openEuler

```bash
sudo dnf install -y cmake
sudo dnf install -y dkms
```

确认：

```bash
dkms --version
cmake --version
```

## FAQ

### SDK 安装包放在哪里？

SDK `.run` 包由 XDL 官方发布源统一管理，本仓库只提供安装和管理入口。

### MD5 校验失败怎么办？

删除 `downloads/<version>/` 下已下载的文件，然后重新执行命令。

### OS 自动识别不符合现场环境怎么办？

使用 `--os` 和 `--arch` 手动指定：

```bash
sudo bash sdk_manager.sh install --os ubuntu --arch x86_64
```

## 发布说明

- **版本 1.6.7.2**（2026-07-15）：XDL SDK 对外交付入口初始发布，支持按平台
  自动选择 SDK 包、MD5 校验、安装/更新/卸载流程、依赖检查和更新失败回滚。

## 修订历史

| 版本 | 日期 | 作者 | 说明 |
| --- | --- | --- | --- |
| 1.6.7.2 | 2026-07-15 | XDL 技术支持团队 | 对外 SDK 交付初始版本 |

## License

本仓库使用 Apache License 2.0，详见 [LICENSE](LICENSE)。