_{选件 · 接线 · 成片}

---

安装

$ uv tool install --from 'git+https://github.com/Tape-Out/xirang#subdirectory=packages/xirang' xirang

_{长命令 xirang，短命令 ran。}

---

常用命令

$ ran new mytimer -t ip/regmap     # 铺一个新仓
$ ran config uart -s fifoDepth=16  # 旋钮的最终取值与面积
$ ran test uart                    # 跑整张测试矩阵
$ ran build soc-mcu                # 生成并综合
$ ran export soc-mcu -f rdl        # 导成 SystemRDL

_{配置来历与矩阵输出}

$ ran config soc-mcu --why gpiob.numPins
gpiob.numPins = 8
  层叠（低到高，越靠下越优先）：
      bsv-default  32   gpio/ip.yaml (default)
    ✔ instance     8    soc-mcu/ip.yaml:12

$ ran test emac
emac  矩阵 7 点
  ✔ Default                bufWords=512  promisc=False
  ✔ BufWords1024PromiscOn  bufWords=1024 promisc=True
    同 PromiscOff          解析下来与 Default 是同一点
5 点实测，0 点不过

---

清单格式

文件	内容
ip.yaml	身份 · 契约 · 旋钮 · 价目表 · 依赖；有 instances 即为装配
regmap.yaml	寄存器与字段，属性名同 SystemRDL 2.0
workspace.yaml	这次用到哪些包
xirang.lock	解析结果与内容摘要，跟着装配走

_清单样例

name: uart
kind: ip
lang: bsv
params:
  fifoDepth: { type: int, default: 8, range: [1, 64] }
features:
  parity:
    type: bool
    default: false
    area: { points: { '1': 23.52 }, per: fifoDepth }

name: soc-switch
bus: apb4
instances:
  - name: sw0
    of: eswitch
    with: { ports: 4, macEntries: 16, vlan: false }
    addr: 0x10000000
deps: { hwcore: ^0.1, amba: ^0.1 }

装配自己不写 RTL。字段细则见 xrspec/regmap.md。

---

导出目标

目标	是什么
rdl	SystemRDL 2.0
ipxact	IP-XACT 1685
core	FuseSoC CAPI2
kconfig	menuconfig 菜单
resolved	解出的配置与来历
tar	自足源码包

---

门禁清单

_十道门禁

门禁	拦下什么
死输入	引脚驱进来的值，模块里一次也没读
未用方法	寄存器接口暴露的方法，实现里没有用到
地址重叠	某个合法配置下，两个寄存器占同一个地址
调度	装配生成 Verilog 时 bsc 报出的规则冲突
价目表失效	价目表量的是另一份生成产物
未计价	改这个旋钮，面积预测不动
未实测	标了价，却没有一行实测打开过这个特性
曲线平坦	参数改了，量出来的面积不变
低估	预测面积低于实测
工作区	清单、源码与锁不一致

---

子包说明

_{八个包，与各自的改动来源}

包	管什么	什么变了会逼它改
xirang-core	清单 schema · 层叠与求解 · 依赖与锁 · 矩阵派生	规范涨版本
xirang-gen	寄存器图 → BSV / C 头 / 测试台 · 装配 → 顶层	目标语言、契约形态
xirang-area	价目表 · 面积预测 · 回填	面积模型
xirang-back	驱动综合与仿真工具	EDA 工具与版本
xirang-out	六种导出目标与读回	别人的格式
xirang-ws	工作区：成员与 status	产品怎么组装
xirang-flow	编排：叶子 · 装配 · 矩阵	质量策略
xirang	命令行	用户界面

---

本地开发

$ git clone --recurse-submodules https://github.com/Tape-Out/xirang && cd xirang
$ uv sync --all-packages && uv run pytest -q && uv run ruff check .

---

相关项目

xrspec 规范 · xrskel 模板

---

许可证

任选其一： MIT · Apache 2.0 · 木兰宽松许可证 第2版