# ecfw

**Repository Path**: jiangwei0512/ecfw

## Basic Information

- **Project Name**: ecfw
- **Description**: EC固件开发。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-17
- **Last Updated**: 2025-10-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 使用方法

## 工具

将`zephyrtools`目录放到电脑的环境变量中，确保其下的工具可以用（目前来看并不是所有工具都需要），比如：

```bash
PS E:\ecfw> ninja --version
1.13.1
```

下载Zephyr的编译工具。理论上它可以通过west工具下载，命令如下：

```bash
(.venv) E:\ecfw>west sdk install
```

由于需要使用Github，所以需要确保网络环境访问该网站是正常的。

如果网络异常，也可以通过其他手段下载，前提是知道它的下载地址，这可以通过官网查看，比如使用Zephyr3.7版本，则可以在[Getting Started Guide — Zephyr Project Documentation](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html)找到下载的地址：

> https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.16.8/zephyr-sdk-0.16.8_windows-x86_64.7z

然后可以通过其他下载工具下载压缩包。

之后解压，并执行其中的`setup.cmd`脚本：

```bash
E:\zephyr-sdk-0.16.8>setup.cmd
Zephyr SDK 0.16.8 Setup

** NOTE **
You only need to run this script once after extracting the Zephyr SDK
distribution bundle archive.

Install host tools [Y,N]?Y
Register Zephyr SDK CMake package [Y,N]?Y

Installing host tools ...
SKIPPED: Windows host tools are not available yet.

Registering Zephyr SDK CMake package ...
Zephyr-sdk (E:/zephyr-sdk-0.16.8/cmake)
has been added to the user package registry in:
HKEY_CURRENT_USER\Software\Kitware\CMake\Packages\Zephyr-sdk


All done.

Press any key to exit ...
```

这样需要的工具就准备好了。

## 第一次操作

1. 双击`venv.bat`打开Python环境，如果是第一次操作，则会创建Python环境，对应的目录是`.venv`。

2. 安装west工具：

```bash
(.venv) E:\ecfw>pip install west
```

安装成功之后就可以在`.venv\Scripts`目录下找到west.exe这个程序。并且可以正常使用该工具：

```bash
(.venv) E:\ecfw>west --version
West version: v1.5.0
```

3. 安装Zephyr需要的Python工具：

```bash
(.venv) E:\ecfw>pip install -r zephyr\scripts\requirements.txt
```

4. 环境导出：

```bash
(.venv) E:\ecfw>west zephyr-export
```

5. Zephyr需要的额外模块下载（**ecfw只需要cmsis和hal_microchip，所以可以删除zephyr\west.yml中其他不需要的模块**）：

```bash
(.venv) E:\ecfw>west update
```

由于需要使用Github，所以需要确保网络环境访问该网站是正常的。

## 后续操作

1. 构建Zephyr及其应用（具体命令见脚本）：

```bash
(.venv) E:\ecfw>build.bat
```

2. 启动QEMU测试生成物（ecfw使用的芯片QEMU不支持，所以无法执行）：

```bash
(.venv) E:\ecfw>build.bat start
c[?7lSeaBIOS (version rel-1.16.3-0-ga6ed6b701f0a-prebuilt.qemu.org)


iPXE (http://ipxe.org) 00:03.0 CA00 PCI2.10 PnP PMM+06FD0F30+06F30F30 CA00



Booting from ROM..
*** Booting Zephyr OS build v3.7.1 ***
Hello World! qemu_x86/atom
```

3. 删除构建中间产物：

```bash
(.venv) E:\ecfw>build.bat clean
```