From 3c934c76bb2ac3172b2bad527a1cb7e8619b1e28 Mon Sep 17 00:00:00 2001 From: Kai Vehmanen Date: Tue, 19 Sep 2023 14:17:49 +0300 Subject: [PATCH] intel_debug: add info for Intel firmware and tplg filenames Add tables documenting the firmare and topology filenames and their locations, as expected by Linux SOF driver. Signed-off-by: Kai Vehmanen --- getting_started/intel_debug/introduction.rst | 51 ++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/getting_started/intel_debug/introduction.rst b/getting_started/intel_debug/introduction.rst index 8109bf7f..78e1bbab 100644 --- a/getting_started/intel_debug/introduction.rst +++ b/getting_started/intel_debug/introduction.rst @@ -117,6 +117,39 @@ 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 ---------------- @@ -124,6 +157,24 @@ The topology file, such as ``/lib/firmware/intel/sof-tplg/sof-hda-generic-2ch.tp 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 -----------