9.5 KiB
9.5 KiB
文档索引
仅根 README.md 为仓库 README；本页为 docs/ 主题表。全路径：REPO_INDEX.md。
HDMI 主文 linux-hdmi/Linux_HDMI_Audio_Roadmap.md · 架构/进度 meta/DOCUMENTATION_ARCHITECTURE.md · 体例 meta/DOCUMENTATION_STYLE.md · LLM 短表 LLM_INDEX.md
docs/ 根（占位）
| 文档 | 说明 |
|---|---|
| LLM_INDEX.md | [ID] 短表 |
| index.md | BMad AI 索引；project-scan / project-context.md |
| WORK_PROGRESS.md | → meta/WORK_PROGRESS.md |
| Linux_HDMI_Audio_Roadmap.md | → linux-hdmi/Linux_HDMI_Audio_Roadmap.md |
BMad 规划产出
| 文档 | 说明 |
|---|---|
| _bmad-output/planning-artifacts/prd.md | PRD：愿景、成功标准、用户旅程、范围、FR/NFR（能力契约）；与 linux-hdmi 路线图、WORK_PROGRESS 互补 |
| _bmad-output/planning-artifacts/architecture.md | 架构决策：Starter、核心决策、实现模式、项目结构、验证结果；与 PRD 冲突时 以 PRD 为准 |
| _bmad-output/planning-artifacts/epics.md | Epic / Story 分解与最终校验（CE 产出） |
| _bmad-output/project-context.md | 面向代理的项目上下文（体例、补丁顺序、验证约定） |
Linux HDMI（核心）
| 文档 | 说明 |
|---|---|
| linux-hdmi/Linux_HDMI_Audio_Roadmap.md | 主路线图：分阶段行动、已排除项、成功标准 |
| linux-hdmi/FIX_PLAN_HDMI_FROM_SOURCE_ANALYSIS.md | 修复计划（基于源码对比）：阶段 A–D、决策分支、不宜投入项；与主路线图互补 |
| linux-hdmi/PHASE_A_DEVICE_MAP_CHROMEOS_COLLECTED.md | 阶段 A：用 audio_topology/collected/ 中 ChromeOS 采集 对照 ALSA device 与 HDMI1/2/3（Kaisa） |
| linux-hdmi/REANALYSIS_Linux_HDMI_Audio_Kaisa.md | 现象、已排除方向、Mainline 5.15 误区、推荐路径 |
| linux-hdmi/CHROMEOS_VS_UBUNTU_HDMI_NOTES.md | ChromeOS 与 Ubuntu 6.17 的 iDisp/HDMI API 对照 |
| linux-hdmi/CHROMEOS_KAISA_AUDIO_KERNEL_PATHS.md | ChromiumOS 5.15 内核：sof_rt5682 / sof_board_helpers 下 HDMI（iDisp） 与 3.5mm（rt5682） 路径研读笔记 |
| linux-hdmi/KERNEL_SRC_LINUX_HWE617_HDMI_3.5MM_PATHS.md | kernel-src（Ubuntu HWE 6.17 树）：上游 sof_rt5682 / sof_board_helpers / hda-dai 下 HDMI 与 3.5mm 实现研读（与 ChromeOS 笔记对照） |
| linux-hdmi/SOURCE_DIFF_CHROMEOS515_UBUNTU617.md | ChromiumOS 5.15 ↔ Ubuntu HWE 6.17 源码对比分析落盘：sof_board_helpers / sof_rt5682 / ipc3-pcm / hda-dai 差异要点与 reference/ diff 索引 |
| linux-hdmi/UPSTREAM_SOF_Kaisa_HDMI_REPRO.md | 提交 SOF/ALSA 上游所需材料与邮件模板 |
| linux-hdmi/OPERATION_Kaisa_SOF_HDMI_Trace.md | 深度 trace：sof_debug、带 IPC 载荷的 dmesg |
| meta/CHROMEOS_vs_UBUNTU617_SOUND_AUTODIFF.md | sound/soc 自动对照摘要（由脚本生成） |
HDMI 现象分流（读哪篇）
| 场景 | 入口文档 |
|---|---|
| 已记录弯路 / 低期望方向（换 tplg、仅换固件、Mainline 5.15 等） | 路线图 · 二、已排除 |
内核 / IPC / STREAM_PCM_PARAMS 对照与修复分支 |
FIX_PLAN…、REANALYSIS…、SOURCE_DIFF… |
| 用户态路由、三平台拓扑总览 | ANALYSIS_Audio.md |
用户态试错 与 内核/IPC 对照 分流：前者以 aplay -L / PipeWire 路由 等现象为主时多查 ANALYSIS；后者以 dmesg 中 IPC/载荷 为主时走 FIX_PLAN / REANALYSIS / 路线图。*
内核构建、补丁与安装
| 文档 | 说明 |
|---|---|
| kernel-src/README.md | 拉取 HWE 6.17 源码、apt source、与 debian/rules 注意 |
| kernel-build/OPERATION_Install_CustomKernel_Ubuntu_HWE617.md | 安装自编 deb、linux-image-unsigned、模块包、Secure Boot |
| kernel-build/OPERATION_ChromeOS_Kernel_Deep_Diff.md | ChromiumOS 5.15 树 unshallow、git log、导出关键文件 diff |
| ../patches/ubuntu-hwe-6.17/README.md | 预置 0001 / 0002（诊断）补丁、如何 PATCH=... 应用 |
| ../patches/ubuntu-hwe-6.17/VERIFY_PATCHES.md | 0001/0002/0003 验证说明与一键脚本入口 |
| ../patches/ubuntu-hwe-6.17/DIFF_SUMMARY.txt | 补丁设计备忘与 smoke 对象文件 |
| ../patches/ubuntu-hwe-6.17/STREAM_PCM_PARAMS_CHROME_UBUNTU_NOTES.md | STREAM_PCM_PARAMS 链路的 Chrome 与 6.17 对照 |
固件、拓扑与采集
| 文档 | 说明 |
|---|---|
| linux-hdmi/SOF_FIRMWARE_TOPO_Kaisa_CHECKLIST.md | 固件与拓扑快照清单 |
| ../audio_topology/OPERATION_Force_Intel_Signed_Firmware.md | intel-signed 固件路径与回退 |
| ../audio_topology/COLLECT.md | 拓扑采集脚本用法（Linux / Windows / ChromeOS） |
| ../audio_topology/collected/README_TRACE_KAISA.md | trace 采集输出说明 |
双系统、进度与总方案
| 文档 | 说明 |
|---|---|
| meta/DOCUMENTATION_STYLE.md | 体例与改写约定：语言、入口互链、命名、术语、进度类分工；全项目文档自检清单 |
| meta/DOCUMENTATION_ARCHITECTURE.md | 文档架构备忘：README / INDEX / REPO_INDEX / BMad 入口关系，进度类文档分工（WORK_PROGRESS、next、路线图），Mermaid 图 |
| meta/PREFLIGHT_NOTES.md | 双树预检失败含义与补树入口（与 preflight-chromeos-ubuntu-diff.sh stderr 对应） |
| meta/WORK_PROGRESS.md | 换机交接、源码克隆、当前结论、Linux HDMI 阶段互链 |
| meta/OPERATION_DualBoot_Ubuntu24_Windows.md | Ubuntu 24.04 与 Windows 双系统 |
| ../audio_topology/REPAIR_Plan_Audio.md | Linux / Windows 分平台修复思路与文档索引 |
| ../audio_topology/ANALYSIS_Audio.md | 三平台对比与技术分析 |
Windows 专项
范围说明（FR20）：Linux HDMI 主线见上表「Linux HDMI」「内核构建」等节；下列为 Windows 排障，非本仓库 PRD 的 Linux HDMI 交付范围，仅作同款硬件交叉参考。
| 文档 | 说明 |
|---|---|
| windows/OPERATION_Windows_Audio.md | CoolStar / ALC5682 全流程 |
| windows/HARDWARE_ID_DRIVER_MAP_Windows.md | 硬件 ID 与驱动映射（若有） |
脚本（仓库根 scripts/）
可发现性（FR19）：验证 / 构建 / 双树 diff 入口如下；细节以各脚本 --help 与 patches/.../VERIFY_PATCHES.md 为准。
| 脚本 | 说明 |
|---|---|
| ../scripts/ubuntu-hwe-617-build.sh | apply / deps / build / install |
| ../scripts/verify-ubuntu-hwe617-0001-patch.sh | 0001 补丁 dry-run |
| ../scripts/verify-ubuntu-hwe617-patches-runtime.sh | 真机：0001 源码 + 0002/0003 运行时（sof_debug、dynamic_debug、可选 speaker-test），成功打印 VERIFY_OK |
| ../scripts/linux-hdmi-followup-workflow.sh | 深度 diff / 上游文档入口 |
| ../scripts/diff-chromeos-ubuntu-sound.sh | ChromeOS 与 6.17 sound/soc 统计 |
| ../scripts/preflight-chromeos-ubuntu-diff.sh | 预检双树并运行上述 diff + export |
| ../scripts/export-chromeos-ubuntu-sound-file-diffs.sh | 导出 ipc3/pcm/hda-dai unified diff |
| ../scripts/collect-kaisa-sof-trace.sh | SOF trace 采集 |