Skip to content

Commit

Permalink
intel_debug: add info for Intel firmware and tplg filenames
Browse files Browse the repository at this point in the history
Add tables documenting the firmare and topology filenames and their
locations, as expected by Linux SOF driver.

Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
  • Loading branch information
kv2019i authored and marc-hb committed Sep 21, 2023
1 parent 8e37a80 commit 3c934c7
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions getting_started/intel_debug/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,64 @@ Linux kernel to query whether or not the firmware authentication is enabled,
which means `dmesg` logs cannot be provided to alert the user to an ME
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
:header-rows: 1

* - Platform
- Firmware load path
- Notes
* - Raptor Lake and older
- /lib/firmware/intel/sof/sof-PLAT.ri
- PLAT = glk, cml, ..., rpl
* - Raptor Lake and older (community signed)
- /lib/firmware/intel/sof/community/sof-PLAT.ri
- PLAT = glk, cml, ..., rpl
* - Meteor Lake and newer
- /lib/firmware/intel/sof-ipc4/PLAT/sof-PLAT.ri
- PLAT = mtl, lnl, ...
* - Meteor Lake and newer (community signed)
- /lib/firmware/intel/sof-ipc4/PLAT/community/sof-PLAT.ri
- PLAT = mtl, lnl, ...
* - Meteor Lake and newer Loadable Module
- /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)
- /lib/firmware/intel/sof-ipc4-lib/PLAT/community/UUID.bin
- PLAT as above, UUID = UUID of the module

Important notices:
- 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 firmware folder and filename can be overridden with "fw_path" and "fw_filename" SOF kernel parameters.
- The loadable module library path can be overridden with "lib_path" SOF kernel parameter.

2. Topology file
----------------

The topology file, such as ``/lib/firmware/intel/sof-tplg/sof-hda-generic-2ch.tplg``, describes the processing graph and controls to
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
:header-rows: 1

* - Platform
- Topology load path
- Notes
* - Raptor Lake and older
- /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
- CONFIG = topology variant needed for detected hardware configuration

Important notices:
- 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.

3. UCM file
-----------

Expand Down

0 comments on commit 3c934c7

Please sign in to comment.