You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
intel_debug: introduction: Split firmware lookup table into two for monolithic and modular
Separate the firmware lookup table for monolithic and modular SOF release
to be able to document the locations and file names the firmware will
be looking for the individual files.
Extend the description of the two type of SOF release and convert the
list-table to a normal table for better descriptions for the
configurations.
Signed-off-by: Peter Ujfalusi <peter.ujfalusi@linux.intel.com>
Copy file name to clipboardExpand all lines: getting_started/intel_debug/introduction.rst
+53-40Lines changed: 53 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -127,7 +127,7 @@ configuration issue.
127
127
128
128
An IPC4 library is a container of a single or multiple modules (bundle) which
129
129
can be loaded to the firmware after it is booted up.
130
-
Library loading is supported on Meteor Lake (ACE1) or newer platforms.
130
+
Library loading is supported on Meteor Lake (ACE1) or newer platforms.
131
131
132
132
Background information: the base firmware always resides in DSP SRAM while the
133
133
loaded library is stored in DRAM memory and only the needed code is copied to
@@ -142,16 +142,24 @@ See :ref:`llext_modules` for technical details.
142
142
143
143
SOF project releases for Intel platforms are either monolithic (only a single firmware binary) or modular (base firmware and external libraries).
144
144
145
-
1.3.1. Modular SOF releases
146
-
---------------------------
145
+
1.3.1. Monolithic SOF releases
146
+
------------------------------
147
147
148
-
See :ref:`loadable-libraries` for details about library support in general.
148
+
The release contains:
149
+
- **sof-PLAT.ri** : The firmware binary
150
+
- **UUID.bin** : Mainly 3rd party libraries identified by UUID. If the library contains multiple modules then a UUID symlink must be provided for each one. Optional, only supported with IPC4 and on Meteor Lake and newer platforms.
149
151
150
-
The released libraries are:
152
+
1.3.2. Modular SOF releases
153
+
---------------------------
154
+
155
+
The release contains:
156
+
- **sof-PLAT.ri** : The base firmware
151
157
- **sof-PLAT-openmodules.ri** : the bundle contains modules for audio processing not included in the base firmware
152
158
- **sof-PLAT-debug.ri** : the bundle contains modules that are needed for firmware debugging and profiling. Used by developers and for bug reporting if needed
153
159
- **UUID.bin** : Mainly 3rd party libraries identified by UUID. If the library contains multiple modules then a UUID symlink must be provided for each one.
154
160
161
+
See :ref:`loadable-libraries` for details about library support in general.
162
+
155
163
Notes:
156
164
- The Kernel will attempt to load \*-openmodules.ri followed by \*-debug.ri from the library path after the base firmware boot if they exist.
157
165
- additional libraries referenced by topology files or drivers will be loaded based on the UUID of the module from the library path.
@@ -160,41 +168,46 @@ Notes:
160
168
1.4 Firmware lookup paths
161
169
-------------------------
162
170
163
-
Linux SOF will look up firmware files at the following paths:
164
-
165
-
.. _intel_firmware_paths:
166
-
.. list-table:: Firmware look-up paths per Intel platform
- 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.
0 commit comments