[Sound-open-firmware] [PATCH 0/3] ASoC: sof: cleanup Kconfig files
Cc: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> Cc: Liam Girdwood <lgirdwood@gmail.com> Cc: Ranjani Sridharan <ranjani.sridharan@linux.intel.com> Cc: Kai Vehmanen <kai.vehmanen@linux.intel.com> Cc: Daniel Baluta <daniel.baluta@nxp.com> Cc: sound-open-firmware@alsa-project.org Cc: alsa-devel@alsa-project.org Some general editing of sound/soc/sof/ Kconfig files: [PATCH 1/3] ASoC: sof: imx: fix Kconfig punctuation [PATCH 2/3] ASoC: sof: intel: fix Kconfig punctuation and wording [PATCH 3/3] ASoC: sof: Kconfig: fix Kconfig punctuation and wording sound/soc/sof/Kconfig | 42 +++++++++++------------ sound/soc/sof/imx/Kconfig | 10 ++--- sound/soc/sof/intel/Kconfig | 62 +++++++++++++++++----------------- 3 files changed, 57 insertions(+), 57 deletions(-)
Add periods at the end of sentences in help text. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> Cc: Liam Girdwood <lgirdwood@gmail.com> Cc: Ranjani Sridharan <ranjani.sridharan@linux.intel.com> Cc: Kai Vehmanen <kai.vehmanen@linux.intel.com> Cc: Daniel Baluta <daniel.baluta@nxp.com> Cc: sound-open-firmware@alsa-project.org Cc: alsa-devel@alsa-project.org --- sound/soc/sof/imx/Kconfig | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) --- linux-next-20201013.orig/sound/soc/sof/imx/Kconfig +++ linux-next-20201013/sound/soc/sof/imx/Kconfig @@ -17,7 +17,7 @@ config SND_SOC_SOF_IMX_OF select SND_SOC_SOF_IMX8M if SND_SOC_SOF_IMX8M_SUPPORT help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_IMX_COMMON tristate @@ -30,7 +30,7 @@ config SND_SOC_SOF_IMX8_SUPPORT depends on IMX_SCU=y || IMX_SCU=SND_SOC_SOF_IMX_OF depends on IMX_DSP=y || IMX_DSP=SND_SOC_SOF_IMX_OF help - This adds support for Sound Open Firmware for NXP i.MX8 platforms + This adds support for Sound Open Firmware for NXP i.MX8 platforms. Say Y if you have such a device. If unsure select "N". @@ -40,13 +40,13 @@ config SND_SOC_SOF_IMX8 select SND_SOC_SOF_XTENSA help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_IMX8M_SUPPORT bool "SOF support for i.MX8M" depends on IMX_DSP=y || IMX_DSP=SND_SOC_SOF_OF help - This adds support for Sound Open Firmware for NXP i.MX8M platforms + This adds support for Sound Open Firmware for NXP i.MX8M platforms. Say Y if you have such a device. If unsure select "N". @@ -56,6 +56,6 @@ config SND_SOC_SOF_IMX8M select SND_SOC_SOF_XTENSA help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. endif ## SND_SOC_SOF_IMX_IMX_TOPLEVEL
Add periods at the end of sentences in help text. Insert a "not" in one place. Fix help text indentation. Remove a duplicate "Intel(R)" in one place. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> Cc: Liam Girdwood <lgirdwood@gmail.com> Cc: Ranjani Sridharan <ranjani.sridharan@linux.intel.com> Cc: Kai Vehmanen <kai.vehmanen@linux.intel.com> Cc: Daniel Baluta <daniel.baluta@nxp.com> Cc: sound-open-firmware@alsa-project.org Cc: alsa-devel@alsa-project.org --- sound/soc/sof/intel/Kconfig | 62 +++++++++++++++++----------------- 1 file changed, 31 insertions(+), 31 deletions(-) --- linux-next-20201013.orig/sound/soc/sof/intel/Kconfig +++ linux-next-20201013/sound/soc/sof/intel/Kconfig @@ -15,7 +15,7 @@ config SND_SOC_SOF_INTEL_ACPI select SND_SOC_SOF_BROADWELL if SND_SOC_SOF_BROADWELL_SUPPORT help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_INTEL_PCI def_tristate SND_SOC_SOF_PCI @@ -31,13 +31,13 @@ config SND_SOC_SOF_INTEL_PCI select SND_SOC_SOF_JASPERLAKE if SND_SOC_SOF_JASPERLAKE_SUPPORT help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_INTEL_HIFI_EP_IPC tristate help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_INTEL_ATOM_HIFI_EP tristate @@ -45,7 +45,7 @@ config SND_SOC_SOF_INTEL_ATOM_HIFI_EP select SND_SOC_SOF_INTEL_HIFI_EP_IPC help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_INTEL_COMMON tristate @@ -55,7 +55,7 @@ config SND_SOC_SOF_INTEL_COMMON select SND_SOC_ACPI if ACPI help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. if SND_SOC_SOF_INTEL_ACPI @@ -72,7 +72,7 @@ config SND_SOC_SOF_BAYTRAIL_SUPPORT recommended for distros. At some point all legacy drivers will be deprecated but not before all userspace firmware/topology/UCM files are made available to downstream distros. - Say Y if you want to enable SOF on Baytrail/Cherrytrail + Say Y if you want to enable SOF on Baytrail/Cherrytrail. If unsure select "N". config SND_SOC_SOF_BAYTRAIL @@ -80,7 +80,7 @@ config SND_SOC_SOF_BAYTRAIL select SND_SOC_SOF_INTEL_ATOM_HIFI_EP help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_BROADWELL_SUPPORT bool "SOF support for Broadwell" @@ -91,11 +91,11 @@ config SND_SOC_SOF_BROADWELL_SUPPORT This option is mutually exclusive with the Haswell/Broadwell legacy driver. If you want to enable SOF on Broadwell you need to deselect the legacy driver first. - SOF does fully support Broadwell yet, so this option is not + SOF does not fully support Broadwell yet, so this option is not recommended for distros. At some point all legacy drivers will be deprecated but not before all userspace firmware/topology/UCM files are made available to downstream distros. - Say Y if you want to enable SOF on Broadwell + Say Y if you want to enable SOF on Broadwell. If unsure select "N". config SND_SOC_SOF_BROADWELL @@ -104,7 +104,7 @@ config SND_SOC_SOF_BROADWELL select SND_SOC_SOF_INTEL_HIFI_EP_IPC help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. endif ## SND_SOC_SOF_INTEL_ACPI @@ -123,7 +123,7 @@ config SND_SOC_SOF_MERRIFIELD select SND_SOC_SOF_INTEL_ATOM_HIFI_EP help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_APOLLOLAKE_SUPPORT bool "SOF support for Apollolake" @@ -138,7 +138,7 @@ config SND_SOC_SOF_APOLLOLAKE select SND_SOC_SOF_HDA_COMMON help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_GEMINILAKE_SUPPORT bool "SOF support for GeminiLake" @@ -153,7 +153,7 @@ config SND_SOC_SOF_GEMINILAKE select SND_SOC_SOF_HDA_COMMON help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_CANNONLAKE_SUPPORT bool "SOF support for Cannonlake" @@ -169,7 +169,7 @@ config SND_SOC_SOF_CANNONLAKE select SND_SOC_SOF_INTEL_SOUNDWIRE_LINK_BASELINE help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_COFFEELAKE_SUPPORT bool "SOF support for CoffeeLake" @@ -185,7 +185,7 @@ config SND_SOC_SOF_COFFEELAKE select SND_SOC_SOF_INTEL_SOUNDWIRE_LINK_BASELINE help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_ICELAKE_SUPPORT bool "SOF support for Icelake" @@ -201,7 +201,7 @@ config SND_SOC_SOF_ICELAKE select SND_SOC_SOF_INTEL_SOUNDWIRE_LINK_BASELINE help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_COMETLAKE tristate @@ -209,7 +209,7 @@ config SND_SOC_SOF_COMETLAKE select SND_SOC_SOF_INTEL_SOUNDWIRE_LINK_BASELINE help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_COMETLAKE_SUPPORT bool @@ -236,7 +236,7 @@ config SND_SOC_SOF_TIGERLAKE select SND_SOC_SOF_INTEL_SOUNDWIRE_LINK_BASELINE help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_ELKHARTLAKE_SUPPORT bool "SOF support for ElkhartLake" @@ -252,7 +252,7 @@ config SND_SOC_SOF_ELKHARTLAKE select SND_SOC_SOF_INTEL_SOUNDWIRE_LINK_BASELINE help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_JASPERLAKE_SUPPORT bool "SOF support for JasperLake" @@ -267,7 +267,7 @@ config SND_SOC_SOF_JASPERLAKE select SND_SOC_SOF_HDA_COMMON help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_HDA_COMMON tristate @@ -275,7 +275,7 @@ config SND_SOC_SOF_HDA_COMMON select SND_SOC_SOF_HDA_LINK_BASELINE help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. if SND_SOC_SOF_HDA_COMMON @@ -285,7 +285,7 @@ config SND_SOC_SOF_HDA_LINK select SND_SOC_SOF_PROBE_WORK_QUEUE help This adds support for HDA links(HDA/HDMI) with Sound Open Firmware - for Intel(R) platforms. + for Intel(R) platforms. Say Y if you want to enable HDA links with SOF. If unsure select "N". @@ -294,7 +294,7 @@ config SND_SOC_SOF_HDA_AUDIO_CODEC depends on SND_SOC_SOF_HDA_LINK help This adds support for HDAudio codecs with Sound Open Firmware - for Intel(R) platforms. + for Intel(R) platforms. Say Y if you want to enable HDAudio codecs with SOF. If unsure select "N". @@ -302,8 +302,8 @@ config SND_SOC_SOF_HDA_PROBES bool "SOF enable probes over HDA" depends on SND_SOC_SOF_DEBUG_PROBES help - This option enables the data probing for Intel(R). - Intel(R) Skylake and newer platforms. + This option enables the data probing for Intel(R) + Skylake and newer platforms. Say Y if you want to enable probes. If unsure, select "N". @@ -314,7 +314,7 @@ config SND_SOC_SOF_HDA_ALWAYS_ENABLE_DMI and disables known workarounds for specific HDAudio platforms. Only use to look into power optimizations on platforms not affected by DMI L1 issues. This option is not recommended. - Say Y if you want to enable DMI Link L1 + Say Y if you want to enable DMI Link L1. If unsure, select "N". endif ## SND_SOC_SOF_HDA_COMMON @@ -324,7 +324,7 @@ config SND_SOC_SOF_HDA_LINK_BASELINE select SND_SOC_SOF_HDA if SND_SOC_SOF_HDA_LINK help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_HDA tristate @@ -333,14 +333,14 @@ config SND_SOC_SOF_HDA select SND_INTEL_DSP_CONFIG help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_INTEL_SOUNDWIRE_LINK bool "SOF support for SoundWire" depends on SOUNDWIRE && ACPI help This adds support for SoundWire with Sound Open Firmware - for Intel(R) platforms. + for Intel(R) platforms. Say Y if you want to enable SoundWire links with SOF. If unsure select "N". @@ -349,14 +349,14 @@ config SND_SOC_SOF_INTEL_SOUNDWIRE_LINK_ select SND_SOC_SOF_INTEL_SOUNDWIRE if SND_SOC_SOF_INTEL_SOUNDWIRE_LINK help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. config SND_SOC_SOF_INTEL_SOUNDWIRE tristate select SOUNDWIRE_INTEL help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + 'select' statements at a higher level. endif ## SND_SOC_SOF_INTEL_PCI
Add periods at the end of sentences in help text. Drop "a" in one place where it is not needed. Fix a verb. Add some capitalization. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> Cc: Liam Girdwood <lgirdwood@gmail.com> Cc: Ranjani Sridharan <ranjani.sridharan@linux.intel.com> Cc: Kai Vehmanen <kai.vehmanen@linux.intel.com> Cc: Daniel Baluta <daniel.baluta@nxp.com> Cc: sound-open-firmware@alsa-project.org Cc: alsa-devel@alsa-project.org --- sound/soc/sof/Kconfig | 42 ++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 21 deletions(-) --- linux-next-20201013.orig/sound/soc/sof/Kconfig +++ linux-next-20201013/sound/soc/sof/Kconfig @@ -2,7 +2,7 @@ config SND_SOC_SOF_TOPLEVEL bool "Sound Open Firmware Support" help - This adds support for Sound Open Firmware (SOF). SOF is a free and + This adds support for Sound Open Firmware (SOF). SOF is 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". @@ -16,8 +16,8 @@ config SND_SOC_SOF_PCI select SND_SOC_ACPI if ACPI help This adds support for PCI enumeration. This option is - required to enable Intel Skylake+ devices - Say Y if you need this option + required to enable Intel Skylake+ devices. + Say Y if you need this option. If unsure select "N". config SND_SOC_SOF_ACPI @@ -28,8 +28,8 @@ config SND_SOC_SOF_ACPI select IOSF_MBI if X86 && PCI help This adds support for ACPI enumeration. This option is required - to enable Intel Broadwell/Baytrail/Cherrytrail devices - Say Y if you need this option + to enable Intel Broadwell/Baytrail/Cherrytrail devices. + Say Y if you need this option. If unsure select "N". config SND_SOC_SOF_OF @@ -54,12 +54,12 @@ config SND_SOC_SOF_DEVELOPER_SUPPORT bool "SOF developer options support" depends on EXPERT help - This option unlock SOF developer options for debug/performance/ + This option unlocks SOF developer options for debug/performance/ code hardening. Distributions should not select this option, only SOF development teams should select it. - Say Y if you are involved in SOF development and need this option - If not, select N + Say Y if you are involved in SOF development and need this option. + If not, select N. if SND_SOC_SOF_DEVELOPER_SUPPORT @@ -72,13 +72,13 @@ config SND_SOC_SOF_NOCODEC_SUPPORT 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 - This option is mutually exclusive with the Intel HDAudio support, - selecting it may have negative impacts and prevent e.g. microphone + controlled externally. + This option is mutually exclusive with the Intel HDAudio support. + Selecting it may have negative impacts and prevent e.g. microphone functionality from being enabled on Intel CoffeeLake and later platforms. Distributions should not select this option! - Say Y if you need this nocodec fallback option + Say Y if you need this nocodec fallback option. If unsure select "N". config SND_SOC_SOF_STRICT_ABI_CHECKS @@ -92,8 +92,8 @@ config SND_SOC_SOF_STRICT_ABI_CHECKS 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 + 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 @@ -114,8 +114,8 @@ config SND_SOC_SOF_FORCE_NOCODEC_MODE 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 + drivers. + Say Y if you need this force nocodec mode option. If unsure select "N". config SND_SOC_SOF_DEBUG_XRUN_STOP @@ -137,12 +137,12 @@ config SND_SOC_SOF_DEBUG_VERBOSE_IPC 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 + This option forces 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 + If you are trying to debug pointer update with position IPCs or where DPIB/posbuf is not ready, select "Y". If unsure select "N". @@ -161,7 +161,7 @@ config SND_SOC_SOF_DEBUG_ENABLE_FIRMWARE help The firmware trace can be enabled either at build-time with this option, or dynamically by setting flags in the SOF core - module parameter (similar to dynamic debug) + module parameter (similar to dynamic debug). If unsure, select "N". config SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST @@ -190,7 +190,7 @@ config SND_SOC_SOF select SND_SOC_SOF_NOCODEC if SND_SOC_SOF_NOCODEC_SUPPORT help This option is not user-selectable but automagically handled by - 'select' statements at a higher level + '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. @@ -199,7 +199,7 @@ 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 + '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.
On 10/13/20 9:56 PM, Randy Dunlap wrote:
Cc: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> Cc: Liam Girdwood <lgirdwood@gmail.com> Cc: Ranjani Sridharan <ranjani.sridharan@linux.intel.com> Cc: Kai Vehmanen <kai.vehmanen@linux.intel.com> Cc: Daniel Baluta <daniel.baluta@nxp.com> Cc: sound-open-firmware@alsa-project.org Cc: alsa-devel@alsa-project.org
Some general editing of sound/soc/sof/ Kconfig files:
Thanks Randy! That looks all good to me, but I see you didn't CC: Mark Brown and Takashi Iwai so not sure if Mark can apply this directly. Might need to resend the series? I also can take this series in the SOF tree and combine it with other changes I am making to Kconfigs to remove hard-coded exclusions, that would mean less churn on the same files.
[PATCH 1/3] ASoC: sof: imx: fix Kconfig punctuation [PATCH 2/3] ASoC: sof: intel: fix Kconfig punctuation and wording [PATCH 3/3] ASoC: sof: Kconfig: fix Kconfig punctuation and wording
sound/soc/sof/Kconfig | 42 +++++++++++------------ sound/soc/sof/imx/Kconfig | 10 ++--- sound/soc/sof/intel/Kconfig | 62 +++++++++++++++++----------------- 3 files changed, 57 insertions(+), 57 deletions(-)
On 10/14/20 7:37 AM, Pierre-Louis Bossart wrote:
On 10/13/20 9:56 PM, Randy Dunlap wrote:
Cc: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> Cc: Liam Girdwood <lgirdwood@gmail.com> Cc: Ranjani Sridharan <ranjani.sridharan@linux.intel.com> Cc: Kai Vehmanen <kai.vehmanen@linux.intel.com> Cc: Daniel Baluta <daniel.baluta@nxp.com> Cc: sound-open-firmware@alsa-project.org Cc: alsa-devel@alsa-project.org
Some general editing of sound/soc/sof/ Kconfig files:
Thanks Randy!
That looks all good to me, but I see you didn't CC: Mark Brown and Takashi Iwai so not sure if Mark can apply this directly. Might need to resend the series?
Oops, my bad.
I also can take this series in the SOF tree and combine it with other changes I am making to Kconfigs to remove hard-coded exclusions, that would mean less churn on the same files.
Please go ahead with this.
[PATCH 1/3] ASoC: sof: imx: fix Kconfig punctuation [PATCH 2/3] ASoC: sof: intel: fix Kconfig punctuation and wording [PATCH 3/3] ASoC: sof: Kconfig: fix Kconfig punctuation and wording
sound/soc/sof/Kconfig | 42 +++++++++++------------ sound/soc/sof/imx/Kconfig | 10 ++--- sound/soc/sof/intel/Kconfig | 62 +++++++++++++++++----------------- 3 files changed, 57 insertions(+), 57 deletions(-)
thanks. -- ~Randy
participants (2)
-
Pierre-Louis Bossart -
Randy Dunlap