7.4 KiB
7.4 KiB
全仓库索引（Index Docs）
Chromebox 音频 / HDMI / 补丁相关路径速查。主题文档表以 docs/INDEX.md 为准。
大目录（不逐文件列举）
| 路径 | 说明 |
|---|---|
.cursor/ |
Cursor 编辑器技能与配置，非项目业务源码 |
kernel-src/linux-hwe-6.17-*/ |
Ubuntu HWE 内核解压树、.dsc / .deb / 构建日志；说明见 kernel-src/README.md |
chromiumos_kernel/v5.15/ |
ChromiumOS 5.15 对照用内核树（浅克隆/sparse 常见） |
_bmad/ |
BMad Method 安装模块（技能与工作流）；总目录见 _bmad/_config/bmad-help.csv |
_bmad-output/ |
BMad 生成物输出目录（若存在）；PRD 见下表 |
_bmad-output/ — BMad 生成物（节选）
| 文件 | 说明 |
|---|---|
| planning-artifacts/prd.md | 产品需求文档（PRD）：愿景、成功标准、用户旅程、范围、FR/NFR |
| project-context.md | 项目上下文（GPC；与 PRD 互补） |
根目录
| 文件 | 说明 |
|---|---|
| README.md | 唯一仓库 README：问题表、任务、文档入口 |
| REPO_INDEX.md | 本文件：全仓库导航 |
| help.md | BMad 菜单码速查（Core / Method / CIS 等） |
| bmad-help.zh-CN.md | _bmad/_config/bmad-help.csv 全表中文对照（脚本生成） |
docs/ — 正式文档
| 文件 / 目录 | 说明 |
|---|---|
| docs/INDEX.md | docs/ 主题索引（Linux HDMI、内核安装、脚本等） |
| docs/meta/DOCUMENTATION_STYLE.md | 文档体例与改写约定（全项目） |
| docs/meta/PREFLIGHT_NOTES.md | 双树预检失败含义与补树入口 |
| docs/WORK_PROGRESS.md | 重定向 → docs/meta/WORK_PROGRESS.md |
| docs/Linux_HDMI_Audio_Roadmap.md | 重定向 → docs/linux-hdmi/Linux_HDMI_Audio_Roadmap.md |
| docs/linux-hdmi/ | HDMI 路线图、重分析、ChromeOS 对照、trace、上游复现 |
| docs/kernel-build/ | 自编内核安装、ChromiumOS 深度 diff 操作 |
| docs/meta/ | 工作进度、双系统、自动 diff 摘要 |
| docs/windows/ | Windows 音频与硬件 ID 文档 |
audio_topology/ — 拓扑、采集、修复计划
| 文件 | 说明 |
|---|---|
| ANALYSIS_Audio.md | 三平台技术分析与对比 |
| REPAIR_Plan_Audio.md | Linux / Windows 分平台修复与文档索引 |
| COLLECT.md | 拓扑采集脚本用法 |
| OPERATION_Force_Intel_Signed_Firmware.md | intel-signed 固件路径与回退 |
| collect_linux_audio_topology.sh | Linux 拓扑与 dmesg 等一键采集 |
| collect_chromeos_audio_topology.sh | ChromeOS 侧采集 |
| collect_shell_audio.sh | Shell 环境采集辅助 |
audio_topology/collected/
真机/脚本生成的 原始采集与 trace（*.txt 为主）；说明见 README_TRACE_KAISA.md。文件随实验累积，按文件名日期与主机名区分。
patches/ubuntu-hwe-6.17/ — Ubuntu HWE 6.17 内核补丁
| 文件 | 说明 |
|---|---|
| README.md | 补丁顺序、PATCH= 应用方式 |
| 0001-*.patch | ipc3-pcm FREE/trigger 与 Chromium 对齐 |
| 0002-*.patch | STREAM_PCM_PARAMS 诊断打印（不改载荷） |
| DIFF_SUMMARY.txt | 补丁设计备忘 |
| STREAM_PCM_PARAMS_CHROME_UBUNTU_NOTES.md | IPC 载荷与 Chrome 对照笔记 |
| reference/ | 导出用 unified diff 文本（ipc3/pcm/hda-dai） |
scripts/ — 仓库脚本
| 脚本 | 说明 |
|---|---|
| ubuntu-hwe-617-build.sh | apply / deps / build / install HWE 6.17 deb |
| verify-ubuntu-hwe617-0001-patch.sh | 0001 补丁 patch --dry-run |
| verify-ubuntu-hwe617-patches-runtime.sh | 真机验证 0001 源码 + 0002/0003 运行时（成功输出 VERIFY_OK） |
| linux-hdmi-followup-workflow.sh | HDMI 后续 diff / 文档入口 |
| diff-chromeos-ubuntu-sound.sh | sound/soc 统计对照 |
| preflight-chromeos-ubuntu-diff.sh | 双树预检并跑 diff + export |
| export-chromeos-ubuntu-sound-file-diffs.sh | 导出关键文件 unified diff |
| collect-kaisa-sof-trace.sh | Kaisa SOF trace 采集 |
| collect-hda-link-ftrace.sh | §6.1：hda_link_dma / set_stream_id / sof_ipc3_pcm_hw_params function_graph |
| export-boards-chrome-ubuntu-diff.sh | 导出 sof_rt5682 / sof_board_helpers Chrome vs 6.17 diff |
kernel-src/ — 内核源码与构建产物
| 条目 | 说明 |
|---|---|
| README.md | apt source、debian/rules、make mrproper 注意 |
linux-hwe-6.17-6.17.0/ |
解压后的内核源码（含 debian/ 时方可 binary-generic） |
*.dsc / *.orig.tar.gz / *.diff.gz |
Ubuntu 源码包元数据与 tarball |
linux-*.deb / full-build.log |
构建产物或日志（视本机是否编过） |
chromiumos_kernel/
对照 ChromeOS 5.15 行为用；克隆与 sparse 说明见 docs/meta/WORK_PROGRESS.md。
_bmad/ — BMad 模块（工具型）
| 条目 | 说明 |
|---|---|
_bmad/_config/bmad-help.csv |
已安装技能与菜单码总表 |
_bmad/core/config.yaml |
Core 模块配置（语言、输出目录等） |
bmb/、bmm/、cis/、tea/、gds/、wds/ 等 |
各子模块技能与工作流 Markdown |
人机速查可配合根目录 help.md。
维护说明
- 新增 正式设计文档：优先放入
docs/并更新 docs/INDEX.md。 - 新增 顶层目录或大目录：在本文件对应小节补一行。
- Index Docs（
bmad-index-docs） 技能：以本文件 +docs/INDEX.md为仓库文档地图即可覆盖主要用例。