# vhdl_testbench_cli

**Repository Path**: xuanyusan/vhdl_testbench_cli

## Basic Information

- **Project Name**: vhdl_testbench_cli
- **Description**: VHDL: Mac操作系统下`制作 test bench` 和 `生成波形 vcd 文件` 的简易工具
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2020-09-17
- **Last Updated**: 2024-01-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vhdl_testbench_cli

#### 介绍
VHDL:` 制作 test bench` 和 `生成波形 vcd 文件` 的简易工具

#### 软件架构
```sh
|- init.sh (初始化文件)
|- bin
    |- ghdl-cli (可执行文件)
|- cli 
    |- ghdl-cli.py(文件操作工具)
|- vhdl (示例)
    |- half_adder
    |- adder
    |- ...
```

#### 安装教程

1. 安装`python3`
    ```sh
    brew install python;
    ```
2. 安装`gtkwave`
    ```sh
    brew cask install gtkwave;
    ```
3. 安装`ghdl`

    详见此[安装教程](https://www.cnblogs.com/xuanyu-10-18/p/12831815.html)

4. 初始化`ghdl-cli`工具
    ```sh
    git clone https://gitee.com/xuanyusan/vhdl_testbench_cli.git
    cd <你的路径>/vhdl_testbench_cli/
    chmod 777 init.sh
    ./init.sh
    ```
    > 如果vhdl_testbench_cli目录更换，需要重新执行init.sh脚本

#### 快速上手
1.  移动到`VHDL`文件所在目录
    ```sh
    $ cd vhdl/half_adder
    ```
2.  开始处理文件
    ```sh
    $ ghdl-cli half_adder.vhd -v a.vcd -o
    ```
3. 输入波形生成`test bench`文件
    ```sh
    a: _-_-
    b: __--
    ```
4. 编译执行生成vcd文件并用gtkwave打开它
    ![img](imgs/vcd_example.png)

5. 使用ghdl-cli可以查阅更详细的说明

#### 注意
1. 在使用的过程中，`VHDL`文件名需与元件名保持一致
2. 不建议多次生成不同名的`test bench`
3. 为了方便使用者的进一步调试，对生成的work-obj93.cf不做删除操作

#### 你不需要注意的是
1. 该工具延续了VHDL语言不区分大小写的规范

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 码云特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5.  码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)