Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,16 +191,11 @@ to gem5's vfio-user server and maps all BARs through the standard vfio-user prot

## Documentation

Detailed technical documentation is available in [`docs/`](docs/):

- [Complete Usage Guide](docs/en/cosim-usage-guide.md) — build, run, test
- [Technical Notes](docs/en/cosim-technical-notes.md) — architecture, pitfalls, fixes
- [MI300X Memory Management](docs/en/mi300x-memory-management.md) — GART, address translation
- [GPU FS Guide](docs/en/gpu-fs-guide.md) — gem5 standalone GPU full-system simulation
- [Guest GPU Init](docs/en/cosim-guest-gpu-init.md) — driver initialization flow
- [Memory Architecture](docs/en/cosim-memory-architecture.md) — shared memory, VRAM routing, DMA
- [Debugging Pitfalls](docs/en/cosim-debugging-pitfalls.md) — common issues and solutions
- [Development Story](docs/en/cosim-dev-story.md) — how this project was built in one day with Claude
Detailed technical documentation is available in [`docs/`](docs/README.md):

- [Getting Started](docs/en/getting-started.md) — build, launch, and run your first HIP test
- [Architecture](docs/en/architecture.md) — system design, memory sharing, address translation
- [Reference](docs/en/reference.md) — parameters, troubleshooting, debugging commands

## License

Expand Down
15 changes: 5 additions & 10 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,16 +161,11 @@ cosim/

## 技术文档

详细技术文档位于 [`docs/`](docs/) 目录下:

- [完整使用指南](docs/zh/cosim-usage-guide.md) — 从编译到运行 HIP 测试的全流程
- [技术笔记](docs/zh/cosim-technical-notes.md) — 架构设计、踩坑记录、修复方案
- [MI300X 内存管理](docs/zh/mi300x-memory-management.md) — GART、地址翻译、内存映射
- [GPU 全系统仿真指南](docs/zh/gpu-fs-guide.md) — gem5 单机 GPU FS 仿真复现
- [Guest GPU 初始化流程](docs/zh/cosim-guest-gpu-init.md) — 驱动加载与设备初始化
- [内存架构](docs/zh/cosim-memory-architecture.md) — 共享内存、VRAM 路由、DMA
- [调试踩坑记录](docs/zh/cosim-debugging-pitfalls.md) — 常见问题与解决方案
- [开发故事](docs/zh/cosim-dev-story.md) — 一天时间用 Claude 构建 cosim-gpu 的全过程
详细技术文档位于 [`docs/`](docs/README.md) 目录下:

- [快速入门](docs/zh/getting-started.md) — 从编译到运行首个 HIP 测试的全流程
- [架构文档](docs/zh/architecture.md) — 系统设计、内存共享、地址翻译
- [参考手册](docs/zh/reference.md) — 参数表、故障排查、调试命令

## 版本矩阵

Expand Down
14 changes: 14 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# QEMU + gem5 MI300X Co-simulation Documentation

Documentation is available in two languages:

- **中文文档 (Chinese)** — 中文版本
- **English Documentation** — English version

## Quick Links

| Document | 中文 | English |
|----------|------|---------|
| Getting Started | [快速入门](zh/getting-started.md) | [Getting Started](en/getting-started.md) |
| Architecture | [架构文档](zh/architecture.md) | [Architecture](en/architecture.md) |
| Reference | [参考手册](zh/reference.md) | [Reference](en/reference.md) |
1,003 changes: 1,003 additions & 0 deletions docs/en/architecture.md

Large diffs are not rendered by default.

26 changes: 0 additions & 26 deletions docs/en/build-disk-china-mirror.md

This file was deleted.

186 changes: 0 additions & 186 deletions docs/en/cosim-debugging-pitfalls.md

This file was deleted.

Loading
Loading