Skip to content

topology2: ipc3: add Cherry Trail RT5677 topology #11279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kv2019i wants to merge 2 commits into from
+1,252 −0
Closed

topology2: ipc3: add Cherry Trail RT5677 topology #11279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18cf3c3
topology2: ipc3: add Cherry Trail RT5677 topology
MaurizioCasciano Aug 18, 2026
c093ab6
topology2: ipc3: fix Yoga Book stereo slot masks
MaurizioCasciano Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions tools/topology/topology2/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ add_custom_target(topologies2 ALL
# Create directory structure to be provided for deployment
COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/target/sof-ipc4-tplg
COMMAND ${CMAKE_COMMAND} -E create_symlink sof-ipc4-tplg ${CMAKE_CURRENT_BINARY_DIR}/target/sof-ace-tplg
COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/target/sof-tplg
COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/target/development
# copy the topology files only to target, preserving symbolic links
COMMAND sh -c "cp -a production/*.tplg \"${CMAKE_CURRENT_BINARY_DIR}/target/sof-ipc4-tplg/\""
COMMAND sh -c "cp -a production/ipc3/*.tplg \"${CMAKE_CURRENT_BINARY_DIR}/target/sof-tplg/\""
COMMAND sh -c "cp -a development/*.tplg \"${CMAKE_CURRENT_BINARY_DIR}/target/development/\""
)

Expand Down Expand Up @@ -37,6 +39,18 @@ add_custom_target(abi_target
DEPENDS abi.conf
)

# Atom platforms use IPC3 even when the source topology is written using the
# topology2 object model. Keep a separate ABI manifest so IPC3 and IPC4 output
# can be built together without changing the existing production topologies.
add_custom_command(OUTPUT abi-ipc3.conf
COMMAND > abi-ipc3.conf ${CMAKE_CURRENT_SOURCE_DIR}/get_abi.sh
${SOF_ROOT_SOURCE_DIRECTORY} "ipc3"
DEPENDS ${SOF_ROOT_SOURCE_DIRECTORY}/src/include/kernel/abi.h
)
add_custom_target(abi_ipc3_target
DEPENDS abi-ipc3.conf
)

add_dependencies(topologies2 topology2_dev topology2_prod)
add_subdirectory(development)
add_subdirectory(production)
29 changes: 29 additions & 0 deletions tools/topology/topology2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,7 @@ variables such as `DMIC_DRIVER_VERSION`, `SSP_BLOB_VERSION`, and `NUM_HDMIS`.

Supported platforms:

* `cht` — Intel Cherry Trail / Atom (IPC3; currently Yoga Book RT5677 only)

@ujfalusi ujfalusi Oct 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder how this will scale?
It is true that we will have a single IPC3 topology built via tplg-targets-ipc3.cmake, but afaik there is no real distinction between cht/apl/tgl when it comes to topology content, it is just that the kernel uses the platform in topology name.

If we add a missing IPC3 topology for a TGL/ADL device, will this still stands?

I would not add any platform or worst, device specific comment or reference for generic things.

* `tgl` — Intel Tiger Lake / Alder Lake (CAVS 2.5)
* `mtl` — Intel Meteor Lake (ACE 1.x)
* `lnl` — Intel Lunar Lake (ACE 2.x)
Expand All @@ -397,10 +398,38 @@ Select the cmake file matching the target platform generation:

| Platform | CMake Target File |
|---|---|
| Cherry Trail IPC3 | `tplg-targets-ipc3.cmake` |
| Tiger Lake / Alder Lake | `tplg-targets-cavs25.cmake` |
| Meteor Lake | `tplg-targets-ace1.cmake` |
| Lunar Lake | `tplg-targets-ace2.cmake` |
| Panther Lake | `tplg-targets-ace3.cmake` |
| HDA generic | `tplg-targets-hda-generic.cmake` |

### Cherry Trail IPC3

Topology2 describes the source format and does not require the target firmware
to use IPC4. Cherry Trail firmware uses IPC3, so its targets are built with a
separate IPC3 ABI manifest and installed under `target/sof-tplg` instead of the
IPC4/ACE topology directory.

The Yoga Book topology can be built directly with:

```bash
cmake --build . --target topology2_prod_ipc3_sof-cht-rt5677
python3 ../tools/topology/topology2/verify-topology.py \
topology/topology2/production/ipc3/sof-cht-rt5677.tplg
```

`sof-cht-rt5677.tplg` configures SSP2 for DSP_B with an inverted bit clock and
non-inverted frame clock, 48 kHz stereo S24_LE, four 25-bit TDM slots, a
4.8 MHz bit clock, and a 19.2 MHz codec MCLK. The Linux `cht_rt5677` machine
driver configures the same frame and activates slots 0 and 1 with mask `0x3`.
IPC3 derives the DAI channel count from the population count of this mask, so
using `0xf` would incorrectly advertise four channels for the stereo stream.
The verifier parses the compiled artifact and rejects changes to the SSP link
or the PCM0/PCM1 stereo contract. Its Yoga Book values are defaults;
command-line options can override the PCM, clock, format, frame, slot-mask, and
sample-width expectations for other topologies. Run `verify-topology.py --help`
for the complete interface.

Development and testing topologies go in `development/tplg-targets.cmake`.
Loading
Loading