[DNM] topology2: add SDW echo reference function topologies

[bardliao]

Add SoundWire echo reference function topologies. Those topologies will be loaded only when the "Loopback_Virtual" DAI link is created by the kernel.

[Copilot]

Pull request overview

This PR refactors and adds SoundWire (SDW) echo reference function topologies that are loaded when the "Loopback_Virtual" DAI link is created by the kernel. The refactoring extracts echo reference configuration from inline definitions into separate, reusable configuration files.

Changes:

• Added three new topology targets for echo reference configurations: amp-only, jack-only, and combined jack-amp
• Extracted jack echo reference configuration from sdw-jack-generic.conf into a new standalone file sdw-jack-echo-ref.conf
• Extracted speaker/amp echo reference configuration from sdw-amp-generic.conf into a new standalone file sdw-amp-echo-ref.conf
• Added conditional includes in cavs-sdw.conf to include echo reference configurations when SDW_ECHO_REF_DAI is enabled

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
tools/topology/topology2/production/tplg-targets-sdca-generic.cmake	Adds three new topology build targets for echo reference function configurations (amp-ref, jack-ref, jack-amp-ref)
tools/topology/topology2/platform/intel/sdw-jack-generic.conf	Removes inline jack echo reference code and replaces with include statement for new separate file
tools/topology/topology2/platform/intel/sdw-jack-echo-ref.conf	New file containing extracted and parameterized jack echo reference configuration
tools/topology/topology2/platform/intel/sdw-amp-generic.conf	Removes inline amp echo reference code and replaces with include statement for new separate file
tools/topology/topology2/platform/intel/sdw-amp-echo-ref.conf	New file containing extracted and parameterized amp echo reference configuration
tools/topology/topology2/cavs-sdw.conf	Adds conditional includes to load echo reference configurations when SDW_ECHO_REF_DAI is enabled

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The conditional logic appears incorrect. This condition includes the jack echo reference configuration when SDW_JACK is "false", but it should logically check if SDW_JACK_ECHO_REF is "true" instead. The current check on SDW_JACK being false is too broad and doesn't directly correlate with whether jack echo reference functionality is needed. This should check "SDW_JACK_ECHO_REF" with value "true" to match the pattern used in sdw-jack-generic.conf line 715.

Suggested change

	IncludeByKey.SDW_JACK {
	"false" "platform/intel/sdw-jack-echo-ref.conf"
	IncludeByKey.SDW_JACK_ECHO_REF {
	"true" "platform/intel/sdw-jack-echo-ref.conf"

[bardliao]

The purpose of the check is to make sure sdw-jack-generic.conf is not loaded. Because sdw-jack-echo-ref.conf is included in sdw-jack-generic.conf and he echo reference components will be duplicated if we include sdw-jack-echo-ref.conf here in that case.
Besides, SDW_JACK_ECHO_REF is checked inside sdw-jack-echo-ref.conf. No need to check it here.

[Copilot]

The variable name contains a spelling error: "SDW_JACK_ECHO_ERF_PIPELINE_ID" should be "SDW_JACK_ECHO_REF_PIPELINE_ID" (ERF -> REF). This inconsistency with the rest of the codebase where all similar variables use "ECHO_REF" (for "Reference") may cause confusion. The same typo appears throughout this file in multiple locations.

[Copilot]

The variable name contains a spelling error: "SDW_SPK_ECHO_ERF_PIPELINE_ID" should be "SDW_SPK_ECHO_REF_PIPELINE_ID" (ERF -> REF). This is inconsistent with other echo reference variables in the codebase which use "ECHO_REF" (for "Reference"). The same typo appears throughout this file in multiple locations.

[lgirdwood]

@bardliao this looks valid.

[Copilot]

The conditional logic appears incorrect. This condition includes the amp echo reference configuration only when NUM_SDW_AMP_LINKS is "0" (no amp links), but amp echo reference should logically be included when SDW_SPK_ECHO_REF is "true" instead. The current logic would include speaker echo reference configuration even when there are no speaker/amp devices, which doesn't make sense. This should check "SDW_SPK_ECHO_REF" with value "true" to match the pattern used in sdw-amp-generic.conf line 1006.

Suggested change

	IncludeByKey.NUM_SDW_AMP_LINKS {
	"0" "platform/intel/sdw-amp-echo-ref.conf"
	IncludeByKey.SDW_SPK_ECHO_REF {
	"true" "platform/intel/sdw-amp-echo-ref.conf"

[bardliao]

Same answer as #10573 (comment)

[bardliao]

Convert it to draft because it seems will impact the original playback topology.

[bardliao]

@lgirdwood @kv2019i @ujfalusi I need your help on the issue. Take the jack pipeline for example. With echo reference the gain.1.1 will route to module-copier.1.$SDW_JACK_ECHO_REF_PIPELINE_ID" and then alh-copier.$SDW_JACK_OUT_STREAM.0, and without echo reference the gain.1.1 will route to alh-copier.$SDW_JACK_OUT_STREAM.0 directly. There is no issue if we build the jack function topology and the jack echo reference topology in a tplg file. But when we build them separately, we will set SDW_JACK_ECHO_REF = false when we build the jack pipeline without echo reference and then set SDW_JACK_ECHO_REF = true when we build the jack echo reference topology. The kernel will load the 2 topologies and as a result gain.1.1 will route to module-copier.1.$SDW_JACK_ECHO_REF_PIPELINE_ID" and alh-copier.$SDW_JACK_OUT_STREAM.0 at the same time.
And we can't assume that the gain.1.1 router will be added by the echo reference topology because we don't know if the echo reference topology will be loaded or not. Any idea to solve the issue?