1# SPDX-License-Identifier: GPL-2.0-only
2menuconfig SND_SOC_SOF_TOPLEVEL
3	bool "Sound Open Firmware Support"
4	help
5	  This adds support for Sound Open Firmware (SOF). SOF is free and
6	  generic open source audio DSP firmware for multiple devices.
7	  Say Y if you have such a device that is supported by SOF.
8	  If unsure select "N".
9
10if SND_SOC_SOF_TOPLEVEL
11
12config SND_SOC_SOF_PCI_DEV
13	tristate
14
15config SND_SOC_SOF_PCI
16	tristate "SOF PCI enumeration support"
17	depends on PCI
18	help
19	  This adds support for PCI enumeration. This option is
20	  required to enable Intel Skylake+ devices.
21	  For backwards-compatibility with previous configurations the selection will
22	  be used as default for platform-specific drivers.
23	  Say Y if you need this option.
24	  If unsure select "N".
25
26config SND_SOC_SOF_ACPI
27	tristate "SOF ACPI enumeration support"
28	depends on ACPI || COMPILE_TEST
29	help
30	  This adds support for ACPI enumeration. This option is required
31	  to enable Intel Broadwell/Baytrail/Cherrytrail devices.
32	  For backwards-compatibility with previous configurations the selection will
33	  be used as default for platform-specific drivers.
34	  Say Y if you need this option.
35	  If unsure select "N".
36
37config SND_SOC_SOF_ACPI_DEV
38	tristate
39
40config SND_SOC_SOF_OF
41	tristate "SOF OF enumeration support"
42	depends on OF || COMPILE_TEST
43	help
44	  This adds support for Device Tree enumeration. This option is
45	  required to enable i.MX8 or Mediatek devices.
46	  Say Y if you need this option. If unsure select "N".
47
48config SND_SOC_SOF_OF_DEV
49	tristate
50
51config SND_SOC_SOF_COMPRESS
52	bool
53	select SND_SOC_COMPRESS
54
55config SND_SOC_SOF_DEBUG_PROBES
56	tristate
57	select SND_SOC_SOF_CLIENT
58	select SND_SOC_COMPRESS
59	help
60	  This option enables the data probing feature that can be used to
61	  gather data directly from specific points of the audio pipeline.
62	  This option is not user-selectable but automagically handled by
63	  'select' statements at a higher level.
64
65config SND_SOC_SOF_CLIENT
66	tristate
67	select AUXILIARY_BUS
68	help
69	  This option is not user-selectable but automagically handled by
70	  'select' statements at a higher level.
71
72config SND_SOC_SOF_DEVELOPER_SUPPORT
73	bool "SOF developer options support"
74	depends on EXPERT && SND_SOC_SOF
75	help
76	  This option unlocks SOF developer options for debug/performance/
77	  code hardening.
78	  Distributions should not select this option, only SOF development
79	  teams should select it.
80	  Say Y if you are involved in SOF development and need this option.
81	  If not, select N.
82
83if SND_SOC_SOF_DEVELOPER_SUPPORT
84
85config SND_SOC_SOF_FORCE_PROBE_WORKQUEUE
86	bool "SOF force probe workqueue"
87	select SND_SOC_SOF_PROBE_WORK_QUEUE
88	help
89	  This option forces the use of a probe workqueue, which is only used
90	  when HDaudio is enabled due to module dependencies. Forcing this
91	  option is intended for debug only, but this should not add any
92	  functional issues in nominal cases.
93	  Say Y if you are involved in SOF development and need this option.
94	  If not, select N.
95
96config SND_SOC_SOF_NOCODEC
97	tristate
98
99config SND_SOC_SOF_NOCODEC_SUPPORT
100	bool "SOF nocodec mode support"
101	help
102	  This adds support for a dummy/nocodec machine driver fallback
103	  option if no known codec is detected. This is typically only
104	  enabled for developers or devices where the sound card is
105	  controlled externally.
106	  This option is mutually exclusive with the Intel HDAudio support.
107	  Selecting it may have negative impacts and prevent e.g. microphone
108	  functionality from being enabled on Intel CoffeeLake and later
109	  platforms.
110	  Distributions should not select this option!
111	  Say Y if you need this nocodec fallback option.
112	  If unsure select "N".
113
114config SND_SOC_SOF_STRICT_ABI_CHECKS
115	bool "SOF strict ABI checks"
116	help
117	  This option enables strict ABI checks for firmware and topology
118	  files.
119	  When these files are more recent than the kernel, the kernel
120	  will handle the functionality it supports and may report errors
121	  during topology creation or run-time usage if new functionality
122	  is invoked.
123	  This option will stop topology creation and firmware load upfront.
124	  It is intended for SOF CI/releases and not for users or distros.
125	  Say Y if you want strict ABI checks for an SOF release.
126	  If you are not involved in SOF releases and CI development,
127	  select "N".
128
129config SND_SOC_SOF_DEBUG
130	bool "SOF debugging features"
131	help
132	  This option can be used to enable or disable individual SOF firmware
133	  and driver debugging options.
134	  Say Y if you are debugging SOF FW or drivers.
135	  If unsure select "N".
136
137if SND_SOC_SOF_DEBUG
138
139config SND_SOC_SOF_FORCE_NOCODEC_MODE
140	bool "SOF force nocodec Mode"
141	depends on SND_SOC_SOF_NOCODEC_SUPPORT
142	help
143	  This forces SOF to use dummy/nocodec as machine driver, even
144	  though there is a codec detected on the real platform. This is
145	  typically only enabled for developers for debug purposes, before
146	  codec/machine driver is ready, or to exclude the impact of those
147	  drivers.
148	  Say Y if you need this force nocodec mode option.
149	  If unsure select "N".
150
151config SND_SOC_SOF_DEBUG_XRUN_STOP
152	bool "SOF stop on XRUN"
153	help
154	  This option forces PCMs to stop on any XRUN event. This is useful to
155	  preserve any trace data and pipeline status prior to the XRUN.
156	  Say Y if you are debugging SOF FW pipeline XRUNs.
157	  If unsure select "N".
158
159config SND_SOC_SOF_DEBUG_VERBOSE_IPC
160	bool "SOF verbose IPC logs"
161	help
162	  This option enables more verbose IPC logs, with command types in
163	  human-readable form instead of just 32-bit hex dumps. This is useful
164	  if you are trying to debug IPC with the DSP firmware.
165	  If unsure select "N".
166
167config SND_SOC_SOF_DEBUG_FORCE_IPC_POSITION
168	bool "SOF force to use IPC for position update on SKL+"
169	help
170	  This option forces to handle stream position update IPCs and run PCM
171	  elapse to inform ALSA about that, on platforms (e.g. Intel SKL+) that
172	  with other approach (e.g. HDAC DPIB/posbuf) to elapse PCM.
173	  On platforms (e.g. Intel SKL-) where position update IPC is the only
174	  one choice, this setting won't impact anything.
175	  If you are trying to debug pointer update with position IPCs or where
176	  DPIB/posbuf is not ready, select "Y".
177	  If unsure select "N".
178
179config SND_SOC_SOF_DEBUG_ENABLE_DEBUGFS_CACHE
180	bool "SOF enable debugfs caching"
181	help
182	  This option enables caching of debugfs
183	  memory -> DSP resource (memory, register, etc)
184	  before the audio DSP is suspended. This will increase the suspend
185	  latency and therefore should be used for debug purposes only.
186	  Say Y if you want to enable caching the memory windows.
187	  If unsure, select "N".
188
189config SND_SOC_SOF_DEBUG_ENABLE_FIRMWARE_TRACE
190	bool "SOF enable firmware trace"
191	help
192	  The firmware trace can be enabled either at build-time with
193	  this option, or dynamically by setting flags in the SOF core
194	  module parameter (similar to dynamic debug).
195	  If unsure, select "N".
196
197config SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST
198	tristate "SOF enable IPC flood test"
199	depends on SND_SOC_SOF
200	select SND_SOC_SOF_CLIENT
201	help
202	  This option enables a separate client device for IPC flood test
203	  which can be used to flood the DSP with test IPCs and gather stats
204	  about response times.
205	  Say Y if you want to enable IPC flood test.
206	  If unsure, select "N".
207
208config SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST_NUM
209	int "Number of IPC flood test clients"
210	range 1 32
211	default 2
212	depends on SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST
213	help
214	  Select the number of IPC flood test clients to be created.
215
216config SND_SOC_SOF_DEBUG_IPC_MSG_INJECTOR
217	tristate "SOF enable IPC message injector"
218	depends on SND_SOC_SOF
219	select SND_SOC_SOF_CLIENT
220	help
221	  This option enables the IPC message injector which can be used to send
222	  crafted IPC messages to the DSP to test its robustness.
223	  Say Y if you want to enable the IPC message injector.
224	  If unsure, select "N".
225
226config SND_SOC_SOF_DEBUG_RETAIN_DSP_CONTEXT
227	bool "SOF retain DSP context on any FW exceptions"
228	help
229	  This option keeps the DSP in D0 state so that firmware debug
230	  information can be retained and dumped to userspace.
231	  Say Y if you want to retain DSP context for FW exceptions.
232	  If unsure, select "N".
233
234endif ## SND_SOC_SOF_DEBUG
235
236endif ## SND_SOC_SOF_DEVELOPER_SUPPORT
237
238config SND_SOC_SOF
239	tristate
240	select SND_SOC_TOPOLOGY
241	select SND_SOC_SOF_NOCODEC if SND_SOC_SOF_NOCODEC_SUPPORT
242	help
243	  This option is not user-selectable but automagically handled by
244	  'select' statements at a higher level.
245	  The selection is made at the top level and does not exactly follow
246	  module dependencies but since the module or built-in type is decided
247	  at the top level it doesn't matter.
248
249config SND_SOC_SOF_PROBE_WORK_QUEUE
250	bool
251	help
252	  This option is not user-selectable but automagically handled by
253	  'select' statements at a higher level.
254	  When selected, the probe is handled in two steps, for example to
255	  avoid lockdeps if request_module is used in the probe.
256
257source "sound/soc/sof/amd/Kconfig"
258source "sound/soc/sof/imx/Kconfig"
259source "sound/soc/sof/intel/Kconfig"
260source "sound/soc/sof/mediatek/Kconfig"
261source "sound/soc/sof/xtensa/Kconfig"
262
263endif
264