QUICK START / ENVIRONMENT SETUP

环境搭建

IMDE(Ingenic MCU Develop Environment)随 SDK 提供,可通过终端环境脚本或 VS Code 扩展使用。两种方式共用同一份 .config、build/ 目录和构建规则,可按使用习惯选择。

运行要求:Python 3.10 或更高版本。SDK 可自动准备缺失的 Python、CMake 和 Ninja;RISC-V 交叉工具链可通过 imde setup-toolchain 安装。首次准备工具需要能够访问君正软件下载服务。

方式一:终端环境脚本

IMDE 无需单独安装。请在 SDK 根目录打开终端,加载对应平台的环境脚本。脚本只在当前终端会话中注册 IMDE 命令、Tab 补全和工具路径,因此每打开一个新终端都需要重新执行。

Linux、macOS 或 Git Bash

source tools/imde/env.sh

Windows PowerShell

. .\tools\imde\env.ps1

加载成功后,环境脚本会自动执行一次 imde doctor,直接显示当前环境与 SDK 配置的就绪状态,无需再次手动执行。

1471FAFF-C779-4AD8-A5C7-C5009CBF434B.png

imde doctor 会检查 Repo 工作区、Bootstrap、Python、CMake、Ninja、RISC-V 工具链、Menuconfig、CMake Presets 和 .config。根据提示处理未通过项后,可在当前终端再次执行 imde doctor 复查。

首次准备工具

Python、CMake 和 Ninja 缺失时,IMDE 会在首次使用时自动准备,并分别保存到 tools/python/、tools/cmake/ 和 tools/make/。若状态检查提示 RISC-V 交叉工具链缺失,请执行:

imde setup-toolchain

工具链准备完成后再次运行 imde doctor,确认各检查项通过,再继续选择 defconfig 和编译固件。

源码目录未就绪

IMDE 只使用当前工作区中已经检出的源码,不会自动拉取源码仓库。若 components/、app/ 或可选目录 test/ 缺失,或检查提示提交版本与 Manifest 不一致,请在 Repo 工作区根目录执行:

repo sync -d

如果源码中存在尚未提交的修改,先提交或暂存修改,再执行同步,避免本地改动与 Manifest 基线混用。

常见检查项与处理方式

Repo 工作区      --> 源码缺失或版本不一致时,执行 repo sync -d
Bootstrap       --> 首次运行后自动初始化;缺失文件时重新加载环境脚本
Python          --> 需要 3.10+;缺失时由 SDK 自动准备
CMake / Ninja   --> 首次使用时自动准备,重新加载终端环境后生效
RISC-V 工具链   --> 缺失或版本不符时执行 imde setup-toolchain
Menuconfig      --> 依赖缺失时查看 doctor 的修复提示
CMake Presets   --> 检查 CMakePresets.json 和默认 preset 配置
.config         --> 使用 imde use-defconfig 选择当前工程的配置

方式二:VS Code 扩展

IMDE 扩展的源码和安装包统一由官方 GitHub 仓库 ingenic-official/MCU-IMDE 维护,版本安装包可从 GitHub Releases 获取。扩展会调用同一套 IMDE 命令,适合在编辑器中完成配置选择、构建、Pinmux 查看和产物检查;终端脚本方式适合 CI 和自动化环境。

安装与启用

  • 在官方 Releases 页面下载所需的 .vsix 安装包。正式版本适合日常开发;名称带 -beta 后缀的版本用于提前验证新功能。

  • 在 VS Code 命令面板执行 Extensions: Install from VSIX...,选择下载的安装包。

  • 重新加载 VS Code 窗口。

  • 使用 VS Code 打开包含 imde.json 的 SDK 根目录,等待扩展完成项目识别。

  • 在命令面板执行 IMDE: Run Doctor,确认环境检查通过。

IMDE 扩展的官方 GitHub Releases 页面

图 1. 官方 GitHub Releases 中的 IMDE 扩展安装包

建议使用 VS Code 1.85 或更高版本。生产开发优先选择正式版本,需要验证尚未进入正式版的功能时再使用 beta 版本。SDK 工程打开后,可从状态栏或 IMDE: Run Doctor 查看环境状态。

常用命令

在命令面板(Ctrl+Shift+P / Cmd+Shift+P)中输入 IMDE 可查看可用操作,常用命令如下:

IMDE: Run Doctor               --> 检查 SDK 环境与工具链状态
IMDE: Select Defconfig         --> 选择并写入工程 defconfig
IMDE: Configure                --> 生成或刷新构建目录
IMDE: Build                    --> 编译当前 SDK 工程
IMDE: FullClean & Build        --> 清理后重新编译
IMDE: GUI Config               --> 打开图形化 Kconfig 配置
IMDE: Pinmux                   --> 查看芯片与 BSP 引脚配置
IMDE: View Map                 --> 查看链接后内存映射
IMDE: Show Artifacts           --> 查看构建产物
IMDE: Setup IntelliSense       --> 根据编译数据库配置 C/C++ 索引