benreynwar/ghdl

Docker镜像文档：ghdl 4.1.0 (基于python3.12.8-slim)

1. 镜像概述

本Docker镜像基于python3.12.8-slim构建，集成了ghdl 4.1.0版本。ghdl是一款开源的VHDL（超高速集成电路硬件描述语言）编译器与模拟器，支持VHDL代码的分析、编译、仿真及波形生成。该镜像结合了轻量级Python环境与VHDL开发工具，为VHDL开发者提供便捷、一致的开发与运行环境。

2. 核心功能与特性

2.1 基础镜像特性

• 基于python3.12.8-slim构建：采用slim版本基础镜像，体积更小，资源占用低，适合开发与部署场景。
• 内置Python 3.12.8环境：支持Python脚本编写，可用于VHDL开发流程的自动化（如仿真控制、结果分析等）。

2.2 ghdl 4.1.0核心功能

• VHDL标准支持：兼容VHDL-87、VHDL-93、VHDL-2002、VHDL-2008及部分VHDL-2019标准。
• 编译与仿真：支持VHDL代码的语法检查、编译（生成目标文件）及仿真执行。
• 多输出格式：可生成多种输出，包括二进制可执行文件、波形文件（如VCD）等，便于调试。
• 命令行工具：提供ghdl命令行工具，支持交互式与非交互式操作。

3. 使用场景与适用范围

3.1 适用场景

• VHDL开发者日常开发：作为本地开发环境，用于VHDL代码的编写、编译与仿真验证。
• CI/CD流程集成：嵌入VHDL项目的持续集成/持续部署流程，实现代码提交后的自动编译、仿真测试。
• 教学与学习环境：为VHDL初学者提供快速搭建的标准化环境，避免本地环境配置复杂问题。

3.2 适用范围

• VHDL硬件设计工程师、FPGA/ASIC开发者。
• 电子工程相关专业的学生及教学人员。
• 需要自动化VHDL开发流程的团队（如结合Python脚本实现批量编译、测试）。

4. 使用方法与配置说明

4.1 基本使用（docker run）

通过以下命令启动容器并进入交互式终端，可直接使用ghdl工具：

bash
docker run -it --rm [镜像名称或ID] /bin/bash

参数说明：

• -it：以交互式终端模式运行。
• --rm：容器退出后自动删除，避免残留。
• 如需访问本地VHDL文件，可通过-v挂载本地目录至容器内（推荐挂载至/workspace作为工作目录）：

bash
docker run -it --rm -v $(pwd):/workspace [镜像名称或ID] /bin/bash

4.2 ghdl基础操作示例

进入容器后，可执行以下ghdl命令（假设本地VHDL文件已挂载至/workspace）：

1. 查看ghdl版本

bash
ghdl -v

2. 分析VHDL文件（语法检查）

bash
cd /workspace
ghdl -a my_design.vhdl  # 分析单个文件
# 或分析多个文件（按依赖顺序）
ghdl -a pkg.vhdl entity.vhdl architecture.vhdl

3. 编译生成仿真可执行文件

bash
ghdl -e my_entity  # 生成名为my_entity的可执行文件（实体名）

4. 运行仿真并生成波形文件

bash
ghdl -r my_entity --vcd=waveform.vcd  # 运行仿真，生成VCD格式波形文件

5. 注意事项

• 该镜像基于python3.12.8-slim，不含图形界面，波形文件（如VCD）需导出至本地后用第三方工具（如GTKWave）查看。
• 挂载本地目录时，确保文件权限正确，避免容器内无法读取/写入文件。
• 如需扩展功能（如添加其他VHDL工具），可基于此镜像构建自定义Dockerfile。