Chips-2.0 技术文档

1. 安装指南

Chips-2.0 可以通过两种方式进行安装：从 GitHub 仓库克隆或者通过 PyPi 包管理器。

从 GitHub 安装

1. 克隆 GitHub 仓库：

   $ git clone --recursive https://github.com/dawsonjon/Chips-2.0.git
   

2. 切换到克隆的目录：

   $ cd Chips-2.0
   

3. 安装 Chips：

   $ sudo python setup install
   

从 PyPi 安装

使用以下命令通过 PyPi 安装 Chips：

$ pip install chips

2. 项目的使用说明

Chips 是一个高级的 FPGA 设计工具，它允许用户使用 Python 设计 FPGA。用户可以定义组件并使用 C 语言编写组件的行为。以下是一个简单的使用例子：

from chips.api.api import *

# 创建一个新的芯片
chip = Chip("knight_rider")

# 定义一个 C 组件
scanner = Component(C_file="""
/* Knight Rider */
int leds = output("leds");
void main(){
    unsigned shifter = 1;
    while(1){
        while(shifter != 0x80){
            fputc(shifter, leds);
            shifter <<= 1;
            wait_clocks(5000000);
        }
        while(shifter != 0x01){
            fputc(shifter, leds);
            shifter >>= 1;
            wait_clocks(5000000);
        }
    }
}
""", inline=True)

# 捕获仿真输出
scanner_output = Response(chip, "scanner", "int")

# 将扫描器添加到芯片并连接
scanner(chip, inputs={}, outputs={"leds": scanner_output})

# 生成可综合的 Verilog 代码
chip.generate_verilog()

# 在 Python 中运行仿真
chip.simulation_reset()
while len(scanner_output) < 16:
    chip.simulation_step()

# 检查结果
print(list(scanner_output))

3. 项目 API 使用文档

Chips 提供了丰富的 API，包括创建芯片、定义组件、连接组件和仿真等。以下是一些关键的 API：

• Chip(name): 创建一个新的芯片实例。
• Component(C_file, inline=False): 创建一个 C 组件。
• Response(chip, component_name, type): 创建一个响应对象，用于捕获组件输出。
• scanner(chip, inputs, outputs): 将组件添加到芯片并定义输入输出。
• chip.generate_verilog(): 生成 Verilog 代码。
• chip.simulation_reset(): 重置仿真。
• chip.simulation_step(): 执行仿真的一步。

4. 项目安装方式

请参考上述“安装指南”部分，项目可以通过 GitHub 或 PyPi 进行安装。