Skip to content

Commit 3c934c7

Browse files
kv2019imarc-hb
authored andcommitted
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 <[email protected]>
1 parent 8e37a80 commit 3c934c7

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

getting_started/intel_debug/introduction.rst

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,13 +117,64 @@ Linux kernel to query whether or not the firmware authentication is enabled,
117117
which means `dmesg` logs cannot be provided to alert the user to an ME
118118
configuration issue.
119119

120+
Linux SOF will look up firmware files at the following paths:
121+
122+
.. list-table:: Firmware look-up paths per Intel platform
123+
:widths: 50 50 25
124+
:header-rows: 1
125+
126+
* - Platform
127+
- Firmware load path
128+
- Notes
129+
* - Raptor Lake and older
130+
- /lib/firmware/intel/sof/sof-PLAT.ri
131+
- PLAT = glk, cml, ..., rpl
132+
* - Raptor Lake and older (community signed)
133+
- /lib/firmware/intel/sof/community/sof-PLAT.ri
134+
- PLAT = glk, cml, ..., rpl
135+
* - Meteor Lake and newer
136+
- /lib/firmware/intel/sof-ipc4/PLAT/sof-PLAT.ri
137+
- PLAT = mtl, lnl, ...
138+
* - Meteor Lake and newer (community signed)
139+
- /lib/firmware/intel/sof-ipc4/PLAT/community/sof-PLAT.ri
140+
- PLAT = mtl, lnl, ...
141+
* - Meteor Lake and newer Loadable Module
142+
- /lib/firmware/intel/sof-ipc4-lib/PLAT/UUID.bin
143+
- PLAT as above, UUID = UUID of the module
144+
* - Meteor Lake and newer Loadable Module (community signed)
145+
- /lib/firmware/intel/sof-ipc4-lib/PLAT/community/UUID.bin
146+
- PLAT as above, UUID = UUID of the module
147+
148+
Important notices:
149+
- 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.
150+
- The firmware folder and filename can be overridden with "fw_path" and "fw_filename" SOF kernel parameters.
151+
- The loadable module library path can be overridden with "lib_path" SOF kernel parameter.
152+
120153
2. Topology file
121154
----------------
122155

123156
The topology file, such as ``/lib/firmware/intel/sof-tplg/sof-hda-generic-2ch.tplg``, describes the processing graph and controls to
124157
be instantiated by the SOF driver. The topology can be regenerated and
125158
reconfigured with tools but requires expert knowledge of the ALSA/ASoC/topology frameworks.
126159

160+
.. list-table:: Firmware topology file look-up paths per Intel platform
161+
:widths: 50 50 25
162+
:header-rows: 1
163+
164+
* - Platform
165+
- Topology load path
166+
- Notes
167+
* - Raptor Lake and older
168+
- /lib/firmware/intel/sof-tplg/sof-CONFIG.tplg
169+
- CONFIG = topology variant needed for detected hardware configuration
170+
* - Meteor Lake and newer
171+
- /lib/firmware/intel/sof-ace-tplg/sof-CONFIG.tplg
172+
- CONFIG = topology variant needed for detected hardware configuration
173+
174+
Important notices:
175+
- 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.
176+
- The topology folder and filename can be overridden with "tplg_path" and "tplg_filename" `snd_sof_pci` kernel parameters.
177+
127178
3. UCM file
128179
-----------
129180

0 commit comments

Comments
 (0)