topology2: add split topologies description by bardliao · Pull Request #507 · thesofproject/sof-docs

bardliao · 2025-01-14T10:00:38Z

Describe what are split topologies and how to create it.

developer_guides/topology2/topology2.rst

ujfalusi · 2025-01-16T09:27:11Z

developer_guides/topology2/topology2.rst

+
+Linux kernel can load multiple topologies, a topology for a single function.
+This feature is useful when a single device is disabled in specific productuds. To achieve this, you need to split
+the topology into multiple tplg files. The split topology files should be named as follows:


I think this is more useful to handle the mix and match nature of things?
Or actually to support SDCA setups with standardized components.

Yeah, lets call out this is to support SDCA standards.

Changed to "This feature is useful to support SDCA setups with standardized components. And no need to create topologies for every new product."

ujfalusi · 2025-01-16T09:28:24Z

developer_guides/topology2/topology2.rst

+.. code-block:: bash
+
+        sdca-jack
+        sdca-<n>amp where n is the amp link numbers


number of amps?

No, it is the amp link number. For example, if there are 2 amps on the same link, n should be 1. I.e. sdca-1amp

Added description for each function

ujfalusi · 2025-01-16T09:29:07Z

developer_guides/topology2/topology2.rst

+
+.. code-block:: bash
+
+        sdca-jack


this handles headphone, headset and line jack?

Yes, it includes the "Jack Out" and "Jack In" PCMs

ujfalusi · 2025-01-16T09:30:18Z

developer_guides/topology2/topology2.rst

+
+        sdca-jack
+        sdca-<n>amp where n is the amp link numbers
+        sdca-mic


chase build mic (analog or DMIC) and headset mic?

sdca-mic is for the build mic that connected to the SDW codecs. Not headset mic. The headset mic is handled by the sdca-jack device.

ujfalusi · 2025-01-16T09:31:15Z

developer_guides/topology2/topology2.rst

+        sdca-jack
+        sdca-<n>amp where n is the amp link numbers
+        sdca-mic
+        dmic-<n>ch where n is the channel numbers. Currently, only 2ch and 4ch are supported.


this is not SNDW connected DMIC or SNDW connected?

'where n is the number of supported channels'

do we have a max number of channels ? best to say either way.

this is not SNDW connected DMIC or SNDW connected?

This is for PCH-DMIC.

do we have a max number of channels ?

Currently only 2 and 4 channels are supported. So the max number of channels is 4.

ujfalusi · 2025-01-16T09:33:02Z

developer_guides/topology2/topology2.rst

+
+.. code-block:: bash
+
+        sof-arl-sdca-2amp-id2.tplg


so in topology it is better to ship sof-arl-sdca-2amp-id[1-256].tplg to cover pretty much any place the 2amp can be?

Not necessary, the BE id of amp is fixed to 2 in the machine driver. Unless there is a special case, otherwise, -id2 is good enough.

ujfalusi · 2025-01-16T09:34:49Z

developer_guides/topology2/topology2.rst

+
+The split topologies are the subset of the monolithic topology. Usually, you just need to add a description with proper
+macro settings to disable the features that you don't need and set the first BE ID that in the topology in the cmake file
+to generate the split topologies.


Can these topologies have dependencies in order of loading them, that one topology refers to some component from other topology?
LIke direct routing audio from mic to speaker via some processing.

We don't support this so far. Currently, all split topologies are independent.

ujfalusi · 2025-01-16T11:15:37Z

developer_guides/topology2/topology2.rst

+        sdca-<n>amp where n is the amp link numbers
+        sdca-mic
+        dmic-<n>ch where n is the channel numbers. Currently, only 2ch and 4ch are supported.
+        sdca-hdmi


SNDW connected display audio or HDA connected display audio in a system where other codecs are SNDW?

HDA connected display audio in a system where other codecs are SNDW.

lgirdwood · 2025-01-16T12:45:54Z

@ranj063 pls review

lgirdwood · 2025-01-20T13:58:44Z

developer_guides/topology2/topology2.rst

+        sof-<platform>-<function>-id<BE id number>.tplg
+
+Where <platform> should be the platform name like mtl, lnl, etc.
+And <platform> is only needed for the DMIC function.
+


I think its worth stating since this is SDCA that most/all SDCA functions we be of the form
sof-sdca-<function>
where they will reside in a platform generic SDCA directory.
If we need to add a platform (where the SDCA function has some hard dependency) we can do
sof-sdca-<function>-platform
I dont link having the ID number in the name, we should be able to define the ID when we instantiate the SDC object in the topology ?
@ranj063 pls chime in

ok, re the ID, now makes more sense when seen together with the cmake

"cavs-sdw\;sof-sdca-2amp-id2\;NUM_SDW_AMP_LINKS=2,SDW_JACK=false,\ SDW_AMP_FEEDBACK=false,SDW_SPK_STREAM=Playback-SmartAmp,NUM_HDMIS=0" "cavs-sdw\;sof-sdca-mic-id4\;SDW_JACK=false,SDW_DMIC=1,NUM_HDMIS=0,\ SDW_DMIC_STREAM=Capture-SmartMic" "cavs-sdw\;sof-sdca-hdmi-id5\;SDW_JACK=false" "cavs-sdw\;sof-sdca-hdmi-id7\;SDW_JACK=false,HDMI1_ID=7,HDMI2_ID=8,HDMI3_ID=9" "cavs-sdw\;sof-arl-dmic-2ch-id5\;PLATFORM=mtl,SDW_JACK=false,NUM_HDMIS=0,NUM_DMICS=2,\ PDM1_MIC_A_ENABLE=0,PDM1_MIC_B_ENABLE=0,DMIC0_ID=5,DMIC1_ID=6,PREPROCESS_PLUGINS=nhlt,\ NHLT_BIN=nhlt-sof-arl-dmic-2ch-id5.bin"

In this case I would tightly tie the ID to the backend i.e. sof-sdca-mic4 instead of sof-sdca-mic-id4 this make its clearer we mean mic4.

I think its worth stating since this is SDCA that most/all SDCA functions we be of the form sof-sdca-<function> where they will reside in a platform generic SDCA directory.

Yes, but sdca is part of the function name. Eventually, we will extend the function to ssp-jack. I updated thesofproject/sof#9668 and now the sdca topologies are defined in tplg-targets-sdca-generic.cmake

If we need to add a platform (where the SDCA function has some hard dependency) we can do sof-sdca-<function>-platform I dont link having the ID number in the name, we should be able to define the ID when we instantiate the SDC object in the topology ? @ranj063 pls chime in

Currently, the platform is only for PCH-DMIC topologies, like sof-ptl-dmic-2ch-id5. And sof-- is the naming convention.

In this case I would tightly tie the ID to the backend i.e. sof-sdca-mic4 instead of sof-sdca-mic-id4 this make its clearer we mean mic4.

It looks like the topology is for the 4th mic, but it is for the mic on the 4th BE. How about sof-sdca-be4-mic, sof-ptl-be5-dmic-2ch?

bardliao · 2025-02-04T07:07:32Z

@lgirdwood @ujfalusi @ranj063 Could you review the PR again? One open is about where should the BE id be present on the topology name. How about sof-sdca-be4-mic, sof-ptl-be5-dmic-2ch?

lgirdwood

LGTM - I will merge once final open is updated.

developer_guides/topology2/topology2.rst

Describe what are split topologies and how to create it. Signed-off-by: Bard Liao <yung-chuan.liao@linux.intel.com>

bardliao requested a review from ujfalusi January 14, 2025 10:00

bardliao requested review from deb-intel, intelkevinputnam, lgirdwood, mmaka1 and mwasko as code owners January 14, 2025 10:00

bardliao mentioned this pull request Jan 14, 2025

load topology for each device thesofproject/linux#5209

Merged

bardliao force-pushed the split-topologies branch 2 times, most recently from ec88ac1 to 974f4da Compare January 16, 2025 09:15

ujfalusi reviewed Jan 16, 2025

View reviewed changes

bardliao force-pushed the split-topologies branch from 974f4da to ebf6107 Compare January 17, 2025 04:03

lgirdwood reviewed Jan 20, 2025

View reviewed changes

bardliao force-pushed the split-topologies branch from ebf6107 to e6ba9c3 Compare January 21, 2025 07:08

bardliao force-pushed the split-topologies branch from e6ba9c3 to 57cae71 Compare February 7, 2025 08:40

bardliao mentioned this pull request Feb 11, 2025

Topology2: add topologies for SDCA functions thesofproject/sof#9668

Merged

lgirdwood reviewed Feb 12, 2025

View reviewed changes

developer_guides/topology2/topology2.rst Outdated Show resolved Hide resolved

topology2: add split topologies description

f55dd29

Describe what are split topologies and how to create it. Signed-off-by: Bard Liao <yung-chuan.liao@linux.intel.com>

bardliao force-pushed the split-topologies branch from 57cae71 to f55dd29 Compare February 13, 2025 03:00

lgirdwood approved these changes Feb 13, 2025

View reviewed changes

lgirdwood merged commit e748500 into thesofproject:master Feb 13, 2025
3 of 4 checks passed

Conversation

bardliao commented Jan 14, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lgirdwood commented Jan 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bardliao commented Feb 4, 2025

Uh oh!

lgirdwood left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants