sound/soc/sof/Kconfig

   1 # SPDX-License-Identifier: GPL-2.0-only
   2 menuconfig 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
  10 if SND_SOC_SOF_TOPLEVEL
  11
  12 config SND_SOC_SOF_PCI_DEV
  13         tristate
  14
  15 config 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
  26 config 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
  37 config SND_SOC_SOF_ACPI_DEV
  38         tristate
  39
  40 config SND_SOC_SOF_OF
  41         tristate "SOF OF enumeration support"
  42         depends on OF
  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
  48 config SND_SOC_SOF_OF_DEV
  49         tristate
  50
  51 config SND_SOC_SOF_COMPRESS
  52         bool
  53         select SND_SOC_COMPRESS
  54
  55 config 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
  65 config 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
  72 config 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
  83 if SND_SOC_SOF_DEVELOPER_SUPPORT
  84
  85 config 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
  96 config SND_SOC_SOF_NOCODEC
  97         tristate
  98
  99 config SND_SOC_SOF_NOCODEC_SUPPORT
 100         bool "SOF nocodec static 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 at build time 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
 114 config 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
 129 config SND_SOC_SOF_ALLOW_FALLBACK_TO_NEWER_IPC_VERSION
 130         bool "SOF allow fallback to newer IPC version"
 131         help
 132           This option will allow the kernel to try to 'fallback' to a newer IPC
 133           version if there are missing firmware files to satisfy the default IPC
 134           version.
 135           IPC version fallback to older versions is not affected by this option,
 136           it is always available.
 137           Say Y if you are involved in SOF development and need this option.
 138           If not, select N.
 139
 140 config SND_SOC_SOF_DEBUG
 141         bool "SOF debugging features"
 142         help
 143           This option can be used to enable or disable individual SOF firmware
 144           and driver debugging options.
 145           Say Y if you are debugging SOF FW or drivers.
 146           If unsure select "N".
 147
 148 if SND_SOC_SOF_DEBUG
 149
 150 config SND_SOC_SOF_NOCODEC_DEBUG_SUPPORT
 151         bool "SOF nocodec debug mode support"
 152         depends on !SND_SOC_SOF_NOCODEC_SUPPORT
 153         help
 154           This adds support for a dummy/nocodec machine driver fallback
 155           option.
 156           Unlike the SND_SOC_SOF_NOCODEC_SUPPORT, this option is NOT
 157           mutually exclusive at build with the Intel HDAudio support. The
 158           selection will be done depending on command line or modprobe.d settings
 159           Distributions should not select this option!
 160           Say Y if you need this nocodec debug fallback option.
 161           If unsure select "N".
 162
 163 config SND_SOC_SOF_FORCE_NOCODEC_MODE
 164         bool "SOF force nocodec Mode"
 165         depends on SND_SOC_SOF_NOCODEC_SUPPORT
 166         help
 167           This forces SOF to use dummy/nocodec as machine driver, even
 168           though there is a codec detected on the real platform. This is
 169           typically only enabled for developers for debug purposes, before
 170           codec/machine driver is ready, or to exclude the impact of those
 171           drivers.
 172           Say Y if you need this force nocodec mode option.
 173           If unsure select "N".
 174
 175 config SND_SOC_SOF_DEBUG_XRUN_STOP
 176         bool "SOF stop on XRUN"
 177         help
 178           This option forces PCMs to stop on any XRUN event. This is useful to
 179           preserve any trace data and pipeline status prior to the XRUN.
 180           Say Y if you are debugging SOF FW pipeline XRUNs.
 181           If unsure select "N".
 182
 183 config SND_SOC_SOF_DEBUG_VERBOSE_IPC
 184         bool "SOF verbose IPC logs"
 185         help
 186           This option enables more verbose IPC logs, with command types in
 187           human-readable form instead of just 32-bit hex dumps. This is useful
 188           if you are trying to debug IPC with the DSP firmware.
 189           If unsure select "N".
 190
 191 config SND_SOC_SOF_DEBUG_FORCE_IPC_POSITION
 192         bool "SOF force to use IPC for position update on SKL+"
 193         help
 194           This option forces to handle stream position update IPCs and run PCM
 195           elapse to inform ALSA about that, on platforms (e.g. Intel SKL+) that
 196           with other approach (e.g. HDAC DPIB/posbuf) to elapse PCM.
 197           On platforms (e.g. Intel SKL-) where position update IPC is the only
 198           one choice, this setting won't impact anything.
 199           If you are trying to debug pointer update with position IPCs or where
 200           DPIB/posbuf is not ready, select "Y".
 201           If unsure select "N".
 202
 203 config SND_SOC_SOF_DEBUG_ENABLE_DEBUGFS_CACHE
 204         bool "SOF enable debugfs caching"
 205         help
 206           This option enables caching of debugfs
 207           memory -> DSP resource (memory, register, etc)
 208           before the audio DSP is suspended. This will increase the suspend
 209           latency and therefore should be used for debug purposes only.
 210           Say Y if you want to enable caching the memory windows.
 211           If unsure, select "N".
 212
 213 config SND_SOC_SOF_DEBUG_ENABLE_FIRMWARE_TRACE
 214         bool "SOF enable firmware trace"
 215         help
 216           The firmware trace can be enabled either at build-time with
 217           this option, or dynamically by setting flags in the SOF core
 218           module parameter (similar to dynamic debug).
 219           If unsure, select "N".
 220
 221 config SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST
 222         tristate "SOF enable IPC flood test"
 223         depends on SND_SOC_SOF
 224         select SND_SOC_SOF_CLIENT
 225         help
 226           This option enables a separate client device for IPC flood test
 227           which can be used to flood the DSP with test IPCs and gather stats
 228           about response times.
 229           Say Y if you want to enable IPC flood test.
 230           If unsure, select "N".
 231
 232 config SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST_NUM
 233         int "Number of IPC flood test clients"
 234         range 1 32
 235         default 2
 236         depends on SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST
 237         help
 238           Select the number of IPC flood test clients to be created.
 239
 240 config SND_SOC_SOF_DEBUG_IPC_MSG_INJECTOR
 241         tristate "SOF enable IPC message injector"
 242         depends on SND_SOC_SOF
 243         select SND_SOC_SOF_CLIENT
 244         help
 245           This option enables the IPC message injector which can be used to send
 246           crafted IPC messages to the DSP to test its robustness.
 247           Say Y if you want to enable the IPC message injector.
 248           If unsure, select "N".
 249
 250 config SND_SOC_SOF_DEBUG_IPC_KERNEL_INJECTOR
 251         tristate "SOF enable IPC kernel injector"
 252         depends on SND_SOC_SOF
 253         select SND_SOC_SOF_CLIENT
 254         help
 255           This option enables the IPC kernel injector which can be used to send
 256           crafted IPC messages to the kernel to test its robustness against
 257           DSP messages.
 258           Say Y if you want to enable the IPC kernel injector.
 259           If unsure, select "N".
 260
 261 config SND_SOC_SOF_DEBUG_RETAIN_DSP_CONTEXT
 262         bool "SOF retain DSP context on any FW exceptions"
 263         help
 264           This option keeps the DSP in D0 state so that firmware debug
 265           information can be retained and dumped to userspace.
 266           Say Y if you want to retain DSP context for FW exceptions.
 267           If unsure, select "N".
 268
 269 endif ## SND_SOC_SOF_DEBUG
 270
 271 endif ## SND_SOC_SOF_DEVELOPER_SUPPORT
 272
 273 config SND_SOC_SOF
 274         tristate
 275         select SND_SOC_TOPOLOGY
 276         select SND_SOC_SOF_NOCODEC if SND_SOC_SOF_NOCODEC_SUPPORT
 277         select SND_SOC_SOF_NOCODEC if SND_SOC_SOF_NOCODEC_DEBUG_SUPPORT
 278         help
 279           This option is not user-selectable but automagically handled by
 280           'select' statements at a higher level.
 281           The selection is made at the top level and does not exactly follow
 282           module dependencies but since the module or built-in type is decided
 283           at the top level it doesn't matter.
 284
 285 config SND_SOC_SOF_PROBE_WORK_QUEUE
 286         bool
 287         help
 288           This option is not user-selectable but automagically handled by
 289           'select' statements at a higher level.
 290           When selected, the probe is handled in two steps, for example to
 291           avoid lockdeps if request_module is used in the probe.
 292
 293 # Supported IPC versions
 294 config SND_SOC_SOF_IPC3
 295         bool
 296
 297 config SND_SOC_SOF_IPC4
 298         bool
 299
 300 source "sound/soc/sof/amd/Kconfig"
 301 source "sound/soc/sof/imx/Kconfig"
 302 source "sound/soc/sof/intel/Kconfig"
 303 source "sound/soc/sof/mediatek/Kconfig"
 304 source "sound/soc/sof/xtensa/Kconfig"
 305
 306 endif