Skip to content

Commit ec88ac1

Browse files
committed
topology2: add split topologies description
Describe what are split topologies and how to create it. Signed-off-by: Bard Liao <yung-chuan.liao@linux.intel.com>
1 parent 6eee88f commit ec88ac1

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

developer_guides/topology2/topology2.rst

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1332,6 +1332,50 @@ You can use the ``-P`` switch to convert a 2.0 configuration file to the 1.0 con
13321332
13331333
alsatplg <-D args=values> -P input.conf -o output.conf
13341334
1335+
Split topologies
1336+
****************
1337+
1338+
Linux kernel can load multiple topologies, a topology for a single function.
1339+
This feature is useful when a single device is disabled in specific productuds. To achieve this, you need to split
1340+
the topology into multiple tplg files. The split topology files should be named as follows:
1341+
1342+
.. code-block:: bash
1343+
1344+
sof-<platform>-<function>-id<BE id number>.tplg
1345+
1346+
Where <platform> should be the platform name like mtl, lnl, etc.
1347+
1348+
Where <function> should be one of
1349+
.. code-block:: bash
1350+
1351+
sdca-jack
1352+
sdca-<n>amp where n is the amp link numbers
1353+
sdca-mic
1354+
dmic-<n>ch where n is the channel numbers. Currently, only 2ch and 4ch are supported.
1355+
sdca-hdmi
1356+
1357+
1358+
For example
1359+
1360+
.. code-block:: bash
1361+
1362+
sof-arl-sdca-2amp-id2.tplg
1363+
sof-arl-sdca-mic-id4.tplg
1364+
sof-arl-dmic-2ch-id5.tplg
1365+
sof-arl-sdca-hdmi-id7.tgpl
1366+
1367+
The split topologies are the subset of the monolithic topology. Usually, you just need to add a description with proper
1368+
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
1369+
to generate the split topologies.
1370+
1371+
For example
1372+
1373+
.. code-block:: bash
1374+
1375+
"cavs-sdw\;sof-arl-sdca-2amp-id2\;PLATFORM=mtl,NUM_SDW_AMP_LINKS=2,SDW_JACK=false,\
1376+
SDW_AMP_FEEDBACK=false,SDW_SPK_STREAM=Playback-SmartAmp,NUM_HDMIS=0"
1377+
1378+
13351379
Topology reminders
13361380
******************
13371381

0 commit comments

Comments
 (0)