Drop redundant and update valuable comments within the file to increase
readability. This patch also revisits module information and kconfig
help strings.
Signed-off-by: Cezary Rojewski <cezary.rojewski@xxxxxxxxx>
Reviewed-by: Amadeusz Sławiński <amadeuszx.slawinski@xxxxxxxxxxxxxxx>
---
sound/soc/intel/boards/Kconfig | 2 +-
sound/soc/intel/boards/bdw_rt286.c | 23 +++++++----------------
2 files changed, 8 insertions(+), 17 deletions(-)
diff --git a/sound/soc/intel/boards/Kconfig b/sound/soc/intel/boards/Kconfig
index 817b4c04bf6a..aa12d7e3dd2f 100644
--- a/sound/soc/intel/boards/Kconfig
+++ b/sound/soc/intel/boards/Kconfig
@@ -85,7 +85,7 @@ config SND_SOC_INTEL_BDW_RT5677_MACH
If unsure select "N".
config SND_SOC_INTEL_BROADWELL_MACH
- tristate "Broadwell Wildcatpoint"
+ tristate "Broadwell with RT286 I2S codec"
depends on I2C
depends on I2C_DESIGNWARE_PLATFORM || COMPILE_TEST
depends on X86_INTEL_LPSS || COMPILE_TEST
diff --git a/sound/soc/intel/boards/bdw_rt286.c b/sound/soc/intel/boards/bdw_rt286.c
index a3351eb04d4d..628c93c75ca1 100644
--- a/sound/soc/intel/boards/bdw_rt286.c
+++ b/sound/soc/intel/boards/bdw_rt286.c
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: GPL-2.0-only
/*
- * Intel Broadwell Wildcatpoint SST Audio
+ * Sound card driver for Intel Broadwell Wildcat Point with Realtek 286
*
* Copyright (C) 2013, Intel Corporation. All rights reserved.
*/
@@ -16,7 +16,7 @@
#include "../../codecs/rt286.h"
static struct snd_soc_jack card_headset;
-/* Headset jack detection DAPM pins */
+
static struct snd_soc_jack_pin card_headset_pins[] = {
{
.pin = "Mic Jack",
@@ -43,18 +43,14 @@ static const struct snd_soc_dapm_widget card_widgets[] = {
};
static const struct snd_soc_dapm_route card_routes[] = {
- /* speaker */
{"Speaker", NULL, "SPOR"},
{"Speaker", NULL, "SPOL"},
- /* HP jack connectors - unknown if we have jack deteck */
{"Headphone Jack", NULL, "HPO Pin"},
- /* other jacks */
{"MIC1", NULL, "Mic Jack"},
{"LINE1", NULL, "Line Jack"},
- /* digital mics */
{"DMIC1 Pin", NULL, "DMIC1"},
{"DMIC2 Pin", NULL, "DMIC2"},
@@ -84,10 +80,10 @@ static int codec_link_hw_params_fixup(struct snd_soc_pcm_runtime *rtd,
struct snd_interval *channels = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
struct snd_interval *rate = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
- /* The ADSP will covert the FE rate to 48k, stereo */
+ /* The ADSP will convert the FE rate to 48kHz, stereo. */
rate->min = rate->max = 48000;
channels->min = channels->max = 2;
- /* set SSP0 to 16 bit */
+ /* Set SSP0 to 16 bit. */
params_set_format(params, SNDRV_PCM_FORMAT_S16_LE);
return 0;
@@ -147,7 +143,6 @@ SND_SOC_DAILINK_DEF(platform, DAILINK_COMP_ARRAY(COMP_PLATFORM("haswell-pcm-audi
SND_SOC_DAILINK_DEF(codec, DAILINK_COMP_ARRAY(COMP_CODEC("i2c-INT343A:00", "rt286-aif1")));
SND_SOC_DAILINK_DEF(ssp0_port, DAILINK_COMP_ARRAY(COMP_CPU("ssp0-port")));
-/* broadwell digital audio interface glue - connects codec <--> CPU */
static struct snd_soc_dai_link card_dai_links[] = {
/* Front End DAI links */
{
@@ -240,14 +235,13 @@ static int card_resume_post(struct snd_soc_card *card)
return 0;
}
-/* use space before codec name to simplify card ID, and simplify driver name */
+/* Use space before codec name to simplify card ID, and simplify driver name. */
#define SOF_CARD_NAME "bdw rt286" /* card name will be 'sof-bdw rt286' */
#define SOF_DRIVER_NAME "SOF"
#define CARD_NAME "broadwell-rt286"
#define DRIVER_NAME NULL /* card name will be used for driver name */
-/* broadwell audio machine driver for WPT + RT286S */
static struct snd_soc_card bdw_rt286_card = {
.owner = THIS_MODULE,
.dai_link = card_dai_links,
@@ -269,14 +263,12 @@ static int bdw_rt286_probe(struct platform_device *pdev)
int ret;
bdw_rt286_card.dev = &pdev->dev;
- /* override platform name, if required */
mach = pdev->dev.platform_data;
ret = snd_soc_fixup_dai_links_platform_name(&bdw_rt286_card, mach->mach_params.platform);
if (ret)
return ret;
- /* set card and driver name */
if (snd_soc_acpi_sof_parent(&pdev->dev)) {
bdw_rt286_card.name = SOF_CARD_NAME;
bdw_rt286_card.driver_name = SOF_DRIVER_NAME;
@@ -308,8 +300,7 @@ static struct platform_driver bdw_rt286_driver = {
module_platform_driver(bdw_rt286_driver)
-/* Module information */
MODULE_AUTHOR("Liam Girdwood, Xingchao Wang");
-MODULE_DESCRIPTION("Intel SST Audio for WPT/Broadwell");
-MODULE_LICENSE("GPL v2");
+MODULE_DESCRIPTION("Sound card driver for Intel Broadwell Wildcat Point with Realtek 286");
+MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:bdw_rt286");
--
2.25.1
