Skip to content

Commit ee5ed7a

Browse files
committed
docs: developer_guides: enrich technical context across all steps in module integration guide
Enrich every step and subsection in the Audio Module Integration Guide (module_integration_guide.rst) with comprehensive technical context, architectural principles, and practical developer directives: - Step 1: Explain architectural separation of concerns (adapter vs math reference vs SIMD acceleration vs IPC serialization) and third-party library placement rules. - Step 2: Detail header subsystem domains, Zephyr logging levels, and provide in-depth operational rules for all lifecycle callbacks (init, prepare, process, set_configuration, get_configuration, reset, and free) along with static linking vs dynamic LLEXT export. - Step 3: Explain RFC 4122 v4 UUID semantics, global collision detection via scripts/gen-uuid-reg.py, and little-endian word swapping in ALSA Topology 2.0 / IPC4. - Step 4: Detail DSP memory tiering, .text.cold/.data.cold linker sections, assert_can_be_cold() validation, and module adapter allocators. - Step 5: Detail SIMD hardware vector unit mechanics, LoadStoreAlignmentCause exceptions, member alignment (__aligned(16)) vs cache line alignment (__aligned(PLATFORM_DCACHE_ALIGN)), and runtime buffer allocation. - Step 6: Detail Kconfig tristate (y/m/n) semantics, architecture dependency gating, CMake target delegation (llext vs static), IPC versioning dispatch, parent tree discovery, and multi-toolchain CI requirements across Cadence XCC, Zephyr SDK GCC, and LLVM/Clang (IAS). - Step 7: Explain ALSA Topology 2.0 object-oriented class syntax, mixer control volsw semantics, pipeline routing, and alsatplg validation. - Step 8: Detail Host Testbench emulation architecture, offline WAV-to-WAV simulation flags, dynamic parameter injection timing, and Valgrind memory integrity verification. - Step 9: Detail Cadence xt-run cycle-accurate simulation, cross-compilation with XtDevTools, MCPS mathematical formula, cache miss/stall analysis, and xt-gprof call-graph bottleneck diagnosis. - Step 10: Detail deployable firmware building with rimage signing, staged artifact hierarchy (.ri, .ldc, .llext), target deployment patterns (local filesystem vs PXE NFS rootfs), driver unbind/bind reload, dmesg milestones, and live trace logging. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
1 parent 3b1f9e4 commit ee5ed7a

1 file changed

Lines changed: 341 additions & 89 deletions

File tree

0 commit comments

Comments
 (0)