sound/soc/sof/Kconfig

   1 # SPDX-License-Identifier: GPL-2.0-only
   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 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         help
  18           This adds support for PCI enumeration. This option is
  19           required to enable Intel Skylake+ devices.
  20           Say Y if you need this option.
  21           If unsure select "N".
  22
  23 config SND_SOC_SOF_ACPI
  24         tristate "SOF ACPI enumeration support"
  25         depends on ACPI || COMPILE_TEST
  26         select SND_SOC_SOF
  27         select SND_SOC_ACPI if ACPI
  28         select IOSF_MBI if X86 && PCI
  29         help
  30           This adds support for ACPI enumeration. This option is required
  31           to enable Intel Broadwell/Baytrail/Cherrytrail devices.
  32           Say Y if you need this option.
  33           If unsure select "N".
  34
  35 config SND_SOC_SOF_OF
  36         tristate "SOF OF enumeration support"
  37         depends on OF || COMPILE_TEST
  38         select SND_SOC_SOF
  39         help
  40           This adds support for Device Tree enumeration. This option is
  41           required to enable i.MX8 devices.
  42           Say Y if you need this option. If unsure select "N".
  43
  44 config SND_SOC_SOF_DEBUG_PROBES
  45         bool "SOF enable data probing"
  46         select SND_SOC_COMPRESS
  47         help
  48           This option enables the data probing feature that can be used to
  49           gather data directly from specific points of the audio pipeline.
  50           Say Y if you want to enable probes.
  51           If unsure, select "N".
  52
  53 config SND_SOC_SOF_DEVELOPER_SUPPORT
  54         bool "SOF developer options support"
  55         depends on EXPERT
  56         help
  57           This option unlocks SOF developer options for debug/performance/
  58           code hardening.
  59           Distributions should not select this option, only SOF development
  60           teams should select it.
  61           Say Y if you are involved in SOF development and need this option.
  62           If not, select N.
  63
  64 if SND_SOC_SOF_DEVELOPER_SUPPORT
  65
  66 config SND_SOC_SOF_NOCODEC
  67         tristate
  68
  69 config SND_SOC_SOF_NOCODEC_SUPPORT
  70         bool "SOF nocodec mode support"
  71         help
  72           This adds support for a dummy/nocodec machine driver fallback
  73           option if no known codec is detected. This is typically only
  74           enabled for developers or devices where the sound card is
  75           controlled externally.
  76           This option is mutually exclusive with the Intel HDAudio support.
  77           Selecting it may have negative impacts and prevent e.g. microphone
  78           functionality from being enabled on Intel CoffeeLake and later
  79           platforms.
  80           Distributions should not select this option!
  81           Say Y if you need this nocodec fallback option.
  82           If unsure select "N".
  83
  84 config SND_SOC_SOF_STRICT_ABI_CHECKS
  85         bool "SOF strict ABI checks"
  86         help
  87           This option enables strict ABI checks for firmware and topology
  88           files.
  89           When these files are more recent than the kernel, the kernel
  90           will handle the functionality it supports and may report errors
  91           during topology creation or run-time usage if new functionality
  92           is invoked.
  93           This option will stop topology creation and firmware load upfront.
  94           It is intended for SOF CI/releases and not for users or distros.
  95           Say Y if you want strict ABI checks for an SOF release.
  96           If you are not involved in SOF releases and CI development,
  97           select "N".
  98
  99 config SND_SOC_SOF_DEBUG
 100         bool "SOF debugging features"
 101         help
 102           This option can be used to enable or disable individual SOF firmware
 103           and driver debugging options.
 104           Say Y if you are debugging SOF FW or drivers.
 105           If unsure select "N".
 106
 107 if SND_SOC_SOF_DEBUG
 108
 109 config SND_SOC_SOF_FORCE_NOCODEC_MODE
 110         bool "SOF force nocodec Mode"
 111         depends on SND_SOC_SOF_NOCODEC_SUPPORT
 112         help
 113           This forces SOF to use dummy/nocodec as machine driver, even
 114           though there is a codec detected on the real platform. This is
 115           typically only enabled for developers for debug purposes, before
 116           codec/machine driver is ready, or to exclude the impact of those
 117           drivers.
 118           Say Y if you need this force nocodec mode option.
 119           If unsure select "N".
 120
 121 config SND_SOC_SOF_DEBUG_XRUN_STOP
 122         bool "SOF stop on XRUN"
 123         help
 124           This option forces PCMs to stop on any XRUN event. This is useful to
 125           preserve any trace data and pipeline status prior to the XRUN.
 126           Say Y if you are debugging SOF FW pipeline XRUNs.
 127           If unsure select "N".
 128
 129 config SND_SOC_SOF_DEBUG_VERBOSE_IPC
 130         bool "SOF verbose IPC logs"
 131         help
 132           This option enables more verbose IPC logs, with command types in
 133           human-readable form instead of just 32-bit hex dumps. This is useful
 134           if you are trying to debug IPC with the DSP firmware.
 135           If unsure select "N".
 136
 137 config SND_SOC_SOF_DEBUG_FORCE_IPC_POSITION
 138         bool "SOF force to use IPC for position update on SKL+"
 139         help
 140           This option forces to handle stream position update IPCs and run PCM
 141           elapse to inform ALSA about that, on platforms (e.g. Intel SKL+) that
 142           with other approach (e.g. HDAC DPIB/posbuf) to elapse PCM.
 143           On platforms (e.g. Intel SKL-) where position update IPC is the only
 144           one choice, this setting won't impact anything.
 145           If you are trying to debug pointer update with position IPCs or where
 146           DPIB/posbuf is not ready, select "Y".
 147           If unsure select "N".
 148
 149 config SND_SOC_SOF_DEBUG_ENABLE_DEBUGFS_CACHE
 150         bool "SOF enable debugfs caching"
 151         help
 152           This option enables caching of debugfs
 153           memory -> DSP resource (memory, register, etc)
 154           before the audio DSP is suspended. This will increase the suspend
 155           latency and therefore should be used for debug purposes only.
 156           Say Y if you want to enable caching the memory windows.
 157           If unsure, select "N".
 158
 159 config SND_SOC_SOF_DEBUG_ENABLE_FIRMWARE_TRACE
 160         bool "SOF enable firmware trace"
 161         help
 162           The firmware trace can be enabled either at build-time with
 163           this option, or dynamically by setting flags in the SOF core
 164           module parameter (similar to dynamic debug).
 165           If unsure, select "N".
 166
 167 config SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST
 168         bool "SOF enable IPC flood test"
 169         help
 170           This option enables the IPC flood test which can be used to flood
 171           the DSP with test IPCs and gather stats about response times.
 172           Say Y if you want to enable IPC flood test.
 173           If unsure, select "N".
 174
 175 config SND_SOC_SOF_DEBUG_RETAIN_DSP_CONTEXT
 176         bool "SOF retain DSP context on any FW exceptions"
 177         help
 178           This option keeps the DSP in D0 state so that firmware debug
 179           information can be retained and dumped to userspace.
 180           Say Y if you want to retain DSP context for FW exceptions.
 181           If unsure, select "N".
 182
 183 endif ## SND_SOC_SOF_DEBUG
 184
 185 endif ## SND_SOC_SOF_DEVELOPER_SUPPORT
 186
 187 config SND_SOC_SOF
 188         tristate
 189         select SND_SOC_TOPOLOGY
 190         select SND_SOC_SOF_NOCODEC if SND_SOC_SOF_NOCODEC_SUPPORT
 191         help
 192           This option is not user-selectable but automagically handled by
 193           'select' statements at a higher level.
 194           The selection is made at the top level and does not exactly follow
 195           module dependencies but since the module or built-in type is decided
 196           at the top level it doesn't matter.
 197
 198 config SND_SOC_SOF_PROBE_WORK_QUEUE
 199         bool
 200         help
 201           This option is not user-selectable but automagically handled by
 202           'select' statements at a higher level.
 203           When selected, the probe is handled in two steps, for example to
 204           avoid lockdeps if request_module is used in the probe.
 205
 206 source "sound/soc/sof/imx/Kconfig"
 207 source "sound/soc/sof/intel/Kconfig"
 208 source "sound/soc/sof/xtensa/Kconfig"
 209
 210 endif