[mirror_ubuntu-focal-kernel.git] / sound / soc / sof / Kconfig

# SPDX-License-Identifier: GPL-2.0-only
config SND_SOC_SOF_TOPLEVEL
	bool "Sound Open Firmware Support"
	help
	  This adds support for Sound Open Firmware (SOF). SOF is a free and
	  generic open source audio DSP firmware for multiple devices.
	  Say Y if you have such a device that is supported by SOF.
	  If unsure select "N".

if SND_SOC_SOF_TOPLEVEL

config SND_SOC_SOF_PCI
	tristate "SOF PCI enumeration support"
	depends on PCI
	select SND_SOC_SOF
	select SND_SOC_ACPI if ACPI
	select SND_SOC_SOF_OPTIONS
	select SND_SOC_SOF_INTEL_PCI if SND_SOC_SOF_INTEL_TOPLEVEL
	help
	  This adds support for PCI enumeration. This option is
	  required to enable Intel Skylake+ devices
	  Say Y if you need this option
	  If unsure select "N".

config SND_SOC_SOF_ACPI
	tristate "SOF ACPI enumeration support"
	depends on ACPI || COMPILE_TEST
	select SND_SOC_SOF
	select SND_SOC_ACPI if ACPI
	select SND_SOC_SOF_OPTIONS
	select SND_SOC_SOF_INTEL_ACPI if SND_SOC_SOF_INTEL_TOPLEVEL
	select IOSF_MBI if X86 && PCI
	help
	  This adds support for ACPI enumeration. This option is required
	  to enable Intel Haswell/Broadwell/Baytrail/Cherrytrail devices
	  Say Y if you need this option
	  If unsure select "N".

config SND_SOC_SOF_OPTIONS
	tristate
	help
	  This option is not user-selectable but automagically handled by
	  'select' statements at a higher level

if SND_SOC_SOF_OPTIONS

config SND_SOC_SOF_NOCODEC
	tristate "SOF nocodec mode Support"
	help
	  This adds support for a dummy/nocodec machine driver fallback
	  option if no known codec is detected. This is typically only
	  enabled for developers or devices where the sound card is
	  controlled externally
	  Say Y if you need this nocodec fallback option
	  If unsure select "N".

config SND_SOC_SOF_STRICT_ABI_CHECKS
	bool "SOF strict ABI checks"
	help
	  This option enables strict ABI checks for firmware and topology
	  files.
	  When these files are more recent than the kernel, the kernel
	  will handle the functionality it supports and may report errors
	  during topology creation or run-time usage if new functionality
	  is invoked.
	  This option will stop topology creation and firmware load upfront.
	  It is intended for SOF CI/releases and not for users or distros.
	  Say Y if you want strict ABI checks for an SOF release
	  If you are not involved in SOF releases and CI development
	  select "N".

config SND_SOC_SOF_DEBUG
	bool "SOF debugging features"
	help
	  This option can be used to enable or disable individual SOF firmware
	  and driver debugging options.
	  Say Y if you are debugging SOF FW or drivers.
	  If unsure select "N".

if SND_SOC_SOF_DEBUG

config SND_SOC_SOF_FORCE_NOCODEC_MODE
	bool "SOF force nocodec Mode"
	depends on SND_SOC_SOF_NOCODEC
	help
	  This forces SOF to use dummy/nocodec as machine driver, even
	  though there is a codec detected on the real platform. This is
	  typically only enabled for developers for debug purposes, before
	  codec/machine driver is ready, or to exclude the impact of those
	  drivers
	  Say Y if you need this force nocodec mode option
	  If unsure select "N".

config SND_SOC_SOF_DEBUG_XRUN_STOP
	bool "SOF stop on XRUN"
	help
	  This option forces PCMs to stop on any XRUN event. This is useful to
	  preserve any trace data ond pipeline status prior to the XRUN.
	  Say Y if you are debugging SOF FW pipeline XRUNs.
	  If unsure select "N".

config SND_SOC_SOF_DEBUG_VERBOSE_IPC
	bool "SOF verbose IPC logs"
	help
	  This option enables more verbose IPC logs, with command types in
	  human-readable form instead of just 32-bit hex dumps. This is useful
	  if you are trying to debug IPC with the DSP firmware.
	  If unsure select "N".

config SND_SOC_SOF_DEBUG_FORCE_IPC_POSITION
	bool "SOF force to use IPC for position update on SKL+"
	help
	  This option force to handle stream position update IPCs and run pcm
	  elapse to inform ALSA about that, on platforms (e.g. Intel SKL+) that
	  with other approach (e.g. HDAC DPIB/posbuf) to elapse PCM.
	  On platforms (e.g. Intel SKL-) where position update IPC is the only
	  one choice, this setting won't impact anything.
	  if you are trying to debug pointer update with position IPCs or where
	  DPIB/posbuf is not ready, select "Y".
	  If unsure select "N".

config SND_SOC_SOF_DEBUG_ENABLE_DEBUGFS_CACHE
	bool "SOF enable debugfs caching"
	help
	  This option enables caching of debugfs
	  memory -> DSP resource (memory, register, etc)
	  before the audio DSP is suspended. This will increase the suspend
	  latency and therefore should be used for debug purposes only.
	  Say Y if you want to enable caching the memory windows.
	  If unsure, select "N".

endif ## SND_SOC_SOF_DEBUG

endif ## SND_SOC_SOF_OPTIONS

config SND_SOC_SOF
	tristate
	select SND_SOC_TOPOLOGY
	help
	  This option is not user-selectable but automagically handled by
	  'select' statements at a higher level
	  The selection is made at the top level and does not exactly follow
	  module dependencies but since the module or built-in type is decided
	  at the top level it doesn't matter.

config SND_SOC_SOF_PROBE_WORK_QUEUE
	bool
	help
	  This option is not user-selectable but automagically handled by
	  'select' statements at a higher level
	  When selected, the probe is handled in two steps, for example to
	  avoid lockdeps if request_module is used in the probe.

source "sound/soc/sof/intel/Kconfig"
source "sound/soc/sof/xtensa/Kconfig"

endif
Commit	Line	Data
ec8f24b7	1	# SPDX-License-Identifier: GPL-2.0-only
7e978fa3 LG	2	config SND_SOC_SOF_TOPLEVEL
	3	bool "Sound Open Firmware Support"
	4	help
	5	This adds support for Sound Open Firmware (SOF). SOF is a 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
	10	if SND_SOC_SOF_TOPLEVEL
	11
	12	config SND_SOC_SOF_PCI
	13	tristate "SOF PCI enumeration support"
	14	depends on PCI
	15	select SND_SOC_SOF
	16	select SND_SOC_ACPI if ACPI
	17	select SND_SOC_SOF_OPTIONS
	18	select SND_SOC_SOF_INTEL_PCI if SND_SOC_SOF_INTEL_TOPLEVEL
	19	help
	20	This adds support for PCI enumeration. This option is
	21	required to enable Intel Skylake+ devices
	22	Say Y if you need this option
	23	If unsure select "N".
	24
	25	config SND_SOC_SOF_ACPI
	26	tristate "SOF ACPI enumeration support"
	27	depends on ACPI \|\| COMPILE_TEST
	28	select SND_SOC_SOF
	29	select SND_SOC_ACPI if ACPI
	30	select SND_SOC_SOF_OPTIONS
	31	select SND_SOC_SOF_INTEL_ACPI if SND_SOC_SOF_INTEL_TOPLEVEL
4c885191	32	select IOSF_MBI if X86 && PCI
7e978fa3 LG	33	help
	34	This adds support for ACPI enumeration. This option is required
	35	to enable Intel Haswell/Broadwell/Baytrail/Cherrytrail devices
	36	Say Y if you need this option
	37	If unsure select "N".
	38
	39	config SND_SOC_SOF_OPTIONS
	40	tristate
	41	help
	42	This option is not user-selectable but automagically handled by
	43	'select' statements at a higher level
	44
	45	if SND_SOC_SOF_OPTIONS
	46
	47	config SND_SOC_SOF_NOCODEC
	48	tristate "SOF nocodec mode Support"
	49	help
	50	This adds support for a dummy/nocodec machine driver fallback
	51	option if no known codec is detected. This is typically only
	52	enabled for developers or devices where the sound card is
	53	controlled externally
	54	Say Y if you need this nocodec fallback option
	55	If unsure select "N".
	56
73affae2 PLB	57	config SND_SOC_SOF_STRICT_ABI_CHECKS
	58	bool "SOF strict ABI checks"
	59	help
	60	This option enables strict ABI checks for firmware and topology
	61	files.
	62	When these files are more recent than the kernel, the kernel
	63	will handle the functionality it supports and may report errors
	64	during topology creation or run-time usage if new functionality
	65	is invoked.
	66	This option will stop topology creation and firmware load upfront.
	67	It is intended for SOF CI/releases and not for users or distros.
	68	Say Y if you want strict ABI checks for an SOF release
	69	If you are not involved in SOF releases and CI development
	70	select "N".
	71
7e978fa3 LG	72	config SND_SOC_SOF_DEBUG
	73	bool "SOF debugging features"
	74	help
	75	This option can be used to enable or disable individual SOF firmware
	76	and driver debugging options.
	77	Say Y if you are debugging SOF FW or drivers.
	78	If unsure select "N".
	79
	80	if SND_SOC_SOF_DEBUG
	81
	82	config SND_SOC_SOF_FORCE_NOCODEC_MODE
	83	bool "SOF force nocodec Mode"
	84	depends on SND_SOC_SOF_NOCODEC
	85	help
	86	This forces SOF to use dummy/nocodec as machine driver, even
	87	though there is a codec detected on the real platform. This is
	88	typically only enabled for developers for debug purposes, before
	89	codec/machine driver is ready, or to exclude the impact of those
	90	drivers
	91	Say Y if you need this force nocodec mode option
	92	If unsure select "N".
	93
	94	config SND_SOC_SOF_DEBUG_XRUN_STOP
	95	bool "SOF stop on XRUN"
	96	help
	97	This option forces PCMs to stop on any XRUN event. This is useful to
	98	preserve any trace data ond pipeline status prior to the XRUN.
	99	Say Y if you are debugging SOF FW pipeline XRUNs.
	100	If unsure select "N".
	101
	102	config SND_SOC_SOF_DEBUG_VERBOSE_IPC
	103	bool "SOF verbose IPC logs"
	104	help
	105	This option enables more verbose IPC logs, with command types in
	106	human-readable form instead of just 32-bit hex dumps. This is useful
	107	if you are trying to debug IPC with the DSP firmware.
	108	If unsure select "N".
	109
	110	config SND_SOC_SOF_DEBUG_FORCE_IPC_POSITION
	111	bool "SOF force to use IPC for position update on SKL+"
	112	help
	113	This option force to handle stream position update IPCs and run pcm
	114	elapse to inform ALSA about that, on platforms (e.g. Intel SKL+) that
	115	with other approach (e.g. HDAC DPIB/posbuf) to elapse PCM.
	116	On platforms (e.g. Intel SKL-) where position update IPC is the only
	117	one choice, this setting won't impact anything.
	118	if you are trying to debug pointer update with position IPCs or where
	119	DPIB/posbuf is not ready, select "Y".
	120	If unsure select "N".
	121
	122	config SND_SOC_SOF_DEBUG_ENABLE_DEBUGFS_CACHE
	123	bool "SOF enable debugfs caching"
	124	help
	125	This option enables caching of debugfs
	126	memory -> DSP resource (memory, register, etc)
	127	before the audio DSP is suspended. This will increase the suspend
	128	latency and therefore should be used for debug purposes only.
	129	Say Y if you want to enable caching the memory windows.
	130	If unsure, select "N".
	131
	132	endif ## SND_SOC_SOF_DEBUG
	133
	134	endif ## SND_SOC_SOF_OPTIONS
	135
136	config SND_SOC_SOF
137	tristate
138	select SND_SOC_TOPOLOGY
139	help
140	This option is not user-selectable but automagically handled by
141	'select' statements at a higher level
142	The selection is made at the top level and does not exactly follow
143	module dependencies but since the module or built-in type is decided
144	at the top level it doesn't matter.
145
146	config SND_SOC_SOF_PROBE_WORK_QUEUE
147	bool
148	help
149	This option is not user-selectable but automagically handled by
150	'select' statements at a higher level
151	When selected, the probe is handled in two steps, for example to
152	avoid lockdeps if request_module is used in the probe.
153
154	source "sound/soc/sof/intel/Kconfig"
155	source "sound/soc/sof/xtensa/Kconfig"
156
157	endif