Skip to content

Commit

Permalink
intel_debug: introduction: Update for pathnames for IPC4 support
Browse files Browse the repository at this point in the history
SOF supports platforms from Tiger Lake with IPC4, update the docuementation
accordingly.

Update the MTL/LNL topology path to follow a generic pattern and add a note
about the need for a symlink for the old path to retain backwards
compatibility with released kernels.

Signed-off-by: Peter Ujfalusi <[email protected]>
  • Loading branch information
ujfalusi authored and lgirdwood committed Oct 20, 2023
1 parent bc438c0 commit f70388a
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions getting_started/intel_debug/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,28 +120,35 @@ configuration issue.
Linux SOF will look up firmware files at the following paths:

.. list-table:: Firmware look-up paths per Intel platform
:widths: 50 50 25
:widths: 55 5 50 25
:header-rows: 1

* - Platform
- IPC type
- Firmware load path
- Notes
* - Raptor Lake and older
- IPC3
- /lib/firmware/intel/sof/sof-PLAT.ri
- PLAT = glk, cml, ..., rpl
* - Raptor Lake and older (community signed)
- IPC3
- /lib/firmware/intel/sof/community/sof-PLAT.ri
- PLAT = glk, cml, ..., rpl
* - Meteor Lake and newer
* - Tiger Lake and newer
- IPC4
- /lib/firmware/intel/sof-ipc4/PLAT/sof-PLAT.ri
- PLAT = mtl, lnl, ...
* - Meteor Lake and newer (community signed)
- PLAT = tgl, adl, rpl, mtl, lnl, ...
* - Tiger Lake and newer (community signed)
- IPC4
- /lib/firmware/intel/sof-ipc4/PLAT/community/sof-PLAT.ri
- PLAT = mtl, lnl, ...
* - Meteor Lake and newer Loadable Module
- PLAT = tgl, adl, rpl, mtl, lnl, ...
* - Tiger Lake and newer Loadable Module
- IPC4
- /lib/firmware/intel/sof-ipc4-lib/PLAT/UUID.bin
- PLAT as above, UUID = UUID of the module
* - Meteor Lake and newer Loadable Module (community signed)
* - Tiger Lake and newer Loadable Module (community signed)
- IPC4
- /lib/firmware/intel/sof-ipc4-lib/PLAT/community/UUID.bin
- PLAT as above, UUID = UUID of the module

Expand All @@ -158,20 +165,24 @@ be instantiated by the SOF driver. The topology can be regenerated and
reconfigured with tools but requires expert knowledge of the ALSA/ASoC/topology frameworks.

.. list-table:: Firmware topology file look-up paths per Intel platform
:widths: 50 50 25
:widths: 50 5 50 25
:header-rows: 1

* - Platform
- IPC type
- Topology load path
- Notes
* - Raptor Lake and older
- IPC3
- /lib/firmware/intel/sof-tplg/sof-CONFIG.tplg
- CONFIG = topology variant needed for detected hardware configuration
* - Meteor Lake and newer
- /lib/firmware/intel/sof-ace-tplg/sof-CONFIG.tplg
* - Tiger Lake and newer
- IPC4
- /lib/firmware/intel/sof-ipc4-tplg/sof-CONFIG.tplg
- CONFIG = topology variant needed for detected hardware configuration

Important notices:
- For compatibility reasons for **Meteor Lake and newer** ``/lib/firmware/intel/sof-ace-tplg`` must be symlinked to ``/lib/firmware/intel/sof-ipc4-tplg``
- The standard Linux firmware search path and order is followed. The above table covers the base "/lib/firmware" case. See https://docs.kernel.org/driver-api/firmware/fw_search_path.html for more information.
- The topology folder and filename can be overridden with "tplg_path" and "tplg_filename" `snd_sof_pci` kernel parameters.

Expand Down

0 comments on commit f70388a

Please sign in to comment.