ALSA: cs35l41: Check hw_config before using it

The driver can receive an empty hw_config, so mark as valid if
successfully read from device tree/ACPI or set by the driver itself.
Platforms not marked with a valid hw config will not be supported.

Signed-off-by: Lucas Tanure <tanureal@opensource.cirrus.com>
Acked-by: Charles Keepax <ckeepax@opensource.cirrus.com>
Link: https://lore.kernel.org/r/20220413083728.10730-3-tanureal@opensource.cirrus.com
Signed-off-by: Takashi Iwai <tiwai@suse.de>

diff --git a/include/sound/cs35l41.h b/include/sound/cs35l41.h
index abcf850f7110eb6a6f9e707b638d4689327d45c8..4200379e0c262542d359aacd8583671bb795078f 100644 (file)
--- a/include/sound/cs35l41.h
+++ b/include/sound/cs35l41.h
@@ -538,7 +538,6 @@
 #define CS35L41_OTP_SIZE_WORDS         32
 #define CS35L41_NUM_OTP_ELEM           100
 
-#define CS35L41_VALID_PDATA            0x80000000
 #define CS35L41_NUM_SUPPLIES            2
 
 #define CS35L41_SCLK_MSTR_MASK         0x10
@@ -753,12 +752,14 @@ enum cs35l41_gpio2_func {
 };
 
 struct cs35l41_gpio_cfg {
+       bool valid;
        bool pol_inv;
        bool out_en;
        unsigned int func;
 };
 
 struct cs35l41_hw_cfg {
+       bool valid;
        int bst_ind;
        int bst_ipk;
        int bst_cap;

diff --git a/sound/pci/hda/cs35l41_hda.c b/sound/pci/hda/cs35l41_hda.c
index b79d6ad4b4f5ae4015e64bfc5b9a28266d9482db..a14ad3b0d516bde47cf6783b554a3c28b32dd8d5 100644 (file)
--- a/sound/pci/hda/cs35l41_hda.c
+++ b/sound/pci/hda/cs35l41_hda.c
@@ -219,46 +219,52 @@ static int cs35l41_hda_apply_properties(struct cs35l41_hda *cs35l41)
        bool internal_boost = false;
        int ret;
 
+       if (!cs35l41->hw_cfg.valid)
+               return -EINVAL;
+
        if (hw_cfg->vspk_always_on) {
                cs35l41->reg_seq = &cs35l41_hda_reg_seq_no_bst;
                return 0;
        }
 
-       if (hw_cfg->bst_ind || hw_cfg->bst_cap || hw_cfg->bst_ipk)
+       if (hw_cfg->bst_ind > 0 || hw_cfg->bst_cap > 0 || hw_cfg->bst_ipk > 0)
                internal_boost = true;
 
-       switch (hw_cfg->gpio1.func) {
-       case CS35L41_NOT_USED:
-               break;
-       case CS35l41_VSPK_SWITCH:
-               regmap_update_bits(cs35l41->regmap, CS35L41_GPIO_PAD_CONTROL,
-                                  CS35L41_GPIO1_CTRL_MASK, 1 << CS35L41_GPIO1_CTRL_SHIFT);
-               break;
-       case CS35l41_SYNC:
-               regmap_update_bits(cs35l41->regmap, CS35L41_GPIO_PAD_CONTROL,
-                                  CS35L41_GPIO1_CTRL_MASK, 2 << CS35L41_GPIO1_CTRL_SHIFT);
-               break;
-       default:
-               dev_err(cs35l41->dev, "Invalid function %d for GPIO1\n", hw_cfg->gpio1.func);
-               return -EINVAL;
+       if (hw_cfg->gpio1.valid) {
+               switch (hw_cfg->gpio1.func) {
+               case CS35L41_NOT_USED:
+                       break;
+               case CS35l41_VSPK_SWITCH:
+                       regmap_update_bits(cs35l41->regmap, CS35L41_GPIO_PAD_CONTROL,
+                                          CS35L41_GPIO1_CTRL_MASK, 1 << CS35L41_GPIO1_CTRL_SHIFT);
+                       break;
+               case CS35l41_SYNC:
+                       regmap_update_bits(cs35l41->regmap, CS35L41_GPIO_PAD_CONTROL,
+                                          CS35L41_GPIO1_CTRL_MASK, 2 << CS35L41_GPIO1_CTRL_SHIFT);
+                       break;
+               default:
+                       dev_err(cs35l41->dev, "Invalid function %d for GPIO1\n",
+                               hw_cfg->gpio1.func);
+                       return -EINVAL;
+               }
        }
 
-       switch (hw_cfg->gpio2.func) {
-       case CS35L41_NOT_USED:
-               break;
-       case CS35L41_INTERRUPT:
-               regmap_update_bits(cs35l41->regmap, CS35L41_GPIO_PAD_CONTROL,
-                                  CS35L41_GPIO2_CTRL_MASK, 2 << CS35L41_GPIO2_CTRL_SHIFT);
-               break;
-       default:
-               dev_err(cs35l41->dev, "Invalid function %d for GPIO2\n", hw_cfg->gpio2.func);
-               return -EINVAL;
+       if (hw_cfg->gpio2.valid) {
+               switch (hw_cfg->gpio2.func) {
+               case CS35L41_NOT_USED:
+                       break;
+               case CS35L41_INTERRUPT:
+                       regmap_update_bits(cs35l41->regmap, CS35L41_GPIO_PAD_CONTROL,
+                                          CS35L41_GPIO2_CTRL_MASK, 2 << CS35L41_GPIO2_CTRL_SHIFT);
+                       break;
+               default:
+                       dev_err(cs35l41->dev, "Invalid GPIO2 function %d\n", hw_cfg->gpio2.func);
+                       return -EINVAL;
+               }
        }
 
        if (internal_boost) {
                cs35l41->reg_seq = &cs35l41_hda_reg_seq_int_bst;
-               if (!(hw_cfg->bst_ind && hw_cfg->bst_cap && hw_cfg->bst_ipk))
-                       return -EINVAL;
                ret = cs35l41_boost_config(cs35l41->dev, cs35l41->regmap,
                                           hw_cfg->bst_ind, hw_cfg->bst_cap, hw_cfg->bst_ipk);
                if (ret)
@@ -334,28 +340,37 @@ static int cs35l41_hda_read_acpi(struct cs35l41_hda *cs35l41, const char *hid, i
        if (ret)
                goto err;
        hw_cfg->gpio1.func = values[cs35l41->index];
+       hw_cfg->gpio1.valid = true;
 
        property = "cirrus,gpio2-func";
        ret = device_property_read_u32_array(physdev, property, values, nval);
        if (ret)
                goto err;
        hw_cfg->gpio2.func = values[cs35l41->index];
+       hw_cfg->gpio2.valid = true;
 
        property = "cirrus,boost-peak-milliamp";
        ret = device_property_read_u32_array(physdev, property, values, nval);
        if (ret == 0)
                hw_cfg->bst_ipk = values[cs35l41->index];
+       else
+               hw_cfg->bst_ipk = -1;
 
        property = "cirrus,boost-ind-nanohenry";
        ret = device_property_read_u32_array(physdev, property, values, nval);
        if (ret == 0)
                hw_cfg->bst_ind = values[cs35l41->index];
+       else
+               hw_cfg->bst_ind = -1;
 
        property = "cirrus,boost-cap-microfarad";
        ret = device_property_read_u32_array(physdev, property, values, nval);
        if (ret == 0)
                hw_cfg->bst_cap = values[cs35l41->index];
+       else
+               hw_cfg->bst_cap = -1;
 
+       hw_cfg->valid = true;
        put_device(physdev);
 
        return 0;
@@ -381,6 +396,7 @@ no_acpi_dsd:
        cs35l41->index = id == 0x40 ? 0 : 1;
        cs35l41->reset_gpio = gpiod_get_index(physdev, NULL, 0, GPIOD_OUT_HIGH);
        cs35l41->hw_cfg.vspk_always_on = true;
+       cs35l41->hw_cfg.valid = true;
        put_device(physdev);
 
        return 0;

diff --git a/sound/soc/codecs/cs35l41-lib.c b/sound/soc/codecs/cs35l41-lib.c
index e5a56bcbb223db92b5be11d95d3286723f8b3004..905c648a8f49c9eb2f15054d91545fc00ee42ff7 100644 (file)
--- a/sound/soc/codecs/cs35l41-lib.c
+++ b/sound/soc/codecs/cs35l41-lib.c
@@ -992,10 +992,20 @@ int cs35l41_boost_config(struct device *dev, struct regmap *regmap, int boost_in
        case 101 ... 200:
                bst_cbst_range = 3;
                break;
-       default:        /* 201 uF and greater */
+       default:
+               if (boost_cap < 0) {
+                       dev_err(dev, "Invalid boost capacitor value: %d nH\n", boost_cap);
+                       return -EINVAL;
+               }
+               /* 201 uF and greater */
                bst_cbst_range = 4;
        }
 
+       if (boost_ipk < 1600 || boost_ipk > 4500) {
+               dev_err(dev, "Invalid boost inductor peak current: %d mA\n", boost_ipk);
+               return -EINVAL;
+       }
+
        ret = regmap_update_bits(regmap, CS35L41_BSTCVRT_COEFF,
                                 CS35L41_BST_K1_MASK | CS35L41_BST_K2_MASK,
                                 cs35l41_bst_k1_table[bst_lbst_val][bst_cbst_range]
@@ -1017,10 +1027,6 @@ int cs35l41_boost_config(struct device *dev, struct regmap *regmap, int boost_in
                return ret;
        }
 
-       if (boost_ipk < 1600 || boost_ipk > 4500) {
-               dev_err(dev, "Invalid boost inductor peak current: %d mA\n", boost_ipk);
-               return -EINVAL;
-       }
        bst_ipk_scaled = ((boost_ipk - 1600) / 50) + 0x10;
 
        ret = regmap_update_bits(regmap, CS35L41_BSTCVRT_PEAK_CUR, CS35L41_BST_IPK_MASK,

diff --git a/sound/soc/codecs/cs35l41.c b/sound/soc/codecs/cs35l41.c
index e76b93c151060090c972f950063d67eeca3ea6ab..90dec80707ea152c3262b35957ca3ac2178c0f2a 100644 (file)
--- a/sound/soc/codecs/cs35l41.c
+++ b/sound/soc/codecs/cs35l41.c
@@ -995,28 +995,24 @@ static int cs35l41_dai_set_sysclk(struct snd_soc_dai *dai,
 
 static int cs35l41_set_pdata(struct cs35l41_private *cs35l41)
 {
+       struct cs35l41_hw_cfg *hw_cfg = &cs35l41->hw_cfg;
        int ret;
 
-       /* Set Platform Data */
-       /* Required */
-       if (cs35l41->hw_cfg.bst_ipk &&
-           cs35l41->hw_cfg.bst_ind && cs35l41->hw_cfg.bst_cap) {
-               ret = cs35l41_boost_config(cs35l41->dev, cs35l41->regmap, cs35l41->hw_cfg.bst_ind,
-                                          cs35l41->hw_cfg.bst_cap, cs35l41->hw_cfg.bst_ipk);
-               if (ret) {
-                       dev_err(cs35l41->dev, "Error in Boost DT config: %d\n", ret);
-                       return ret;
-               }
-       } else {
-               dev_err(cs35l41->dev, "Incomplete Boost component DT config\n");
+       if (!hw_cfg->valid)
                return -EINVAL;
+
+       /* Required */
+       ret = cs35l41_boost_config(cs35l41->dev, cs35l41->regmap,
+                                  hw_cfg->bst_ind, hw_cfg->bst_cap, hw_cfg->bst_ipk);
+       if (ret) {
+               dev_err(cs35l41->dev, "Error in Boost DT config: %d\n", ret);
+               return ret;
        }
 
        /* Optional */
-       if (cs35l41->hw_cfg.dout_hiz <= CS35L41_ASP_DOUT_HIZ_MASK &&
-           cs35l41->hw_cfg.dout_hiz >= 0)
+       if (hw_cfg->dout_hiz <= CS35L41_ASP_DOUT_HIZ_MASK && hw_cfg->dout_hiz >= 0)
                regmap_update_bits(cs35l41->regmap, CS35L41_SP_HIZ_CTRL, CS35L41_ASP_DOUT_HIZ_MASK,
-                                  cs35l41->hw_cfg.dout_hiz);
+                                  hw_cfg->dout_hiz);
 
        return 0;
 }
@@ -1037,16 +1033,28 @@ static int cs35l41_gpio_config(struct cs35l41_private *cs35l41)
                           gpio2->pol_inv << CS35L41_GPIO_POL_SHIFT |
                           !gpio2->out_en << CS35L41_GPIO_DIR_SHIFT);
 
-       regmap_update_bits(cs35l41->regmap, CS35L41_GPIO_PAD_CONTROL,
-                          CS35L41_GPIO1_CTRL_MASK | CS35L41_GPIO2_CTRL_MASK,
-                          gpio1->func << CS35L41_GPIO1_CTRL_SHIFT |
-                          gpio2->func << CS35L41_GPIO2_CTRL_SHIFT);
+       if (gpio1->valid)
+               regmap_update_bits(cs35l41->regmap, CS35L41_GPIO_PAD_CONTROL,
+                                  CS35L41_GPIO1_CTRL_MASK,
+                                  gpio1->func << CS35L41_GPIO1_CTRL_SHIFT);
 
-       if ((gpio2->func == (CS35L41_GPIO2_INT_PUSH_PULL_LOW | CS35L41_VALID_PDATA)) ||
-               (gpio2->func == (CS35L41_GPIO2_INT_OPEN_DRAIN | CS35L41_VALID_PDATA)))
-               irq_pol = IRQF_TRIGGER_LOW;
-       else if (gpio2->func == (CS35L41_GPIO2_INT_PUSH_PULL_HIGH | CS35L41_VALID_PDATA))
-               irq_pol = IRQF_TRIGGER_HIGH;
+       if (gpio2->valid) {
+               regmap_update_bits(cs35l41->regmap, CS35L41_GPIO_PAD_CONTROL,
+                                  CS35L41_GPIO2_CTRL_MASK,
+                                  gpio2->func << CS35L41_GPIO2_CTRL_SHIFT);
+
+               switch (gpio2->func) {
+               case CS35L41_GPIO2_INT_PUSH_PULL_LOW:
+               case CS35L41_GPIO2_INT_OPEN_DRAIN:
+                       irq_pol = IRQF_TRIGGER_LOW;
+                       break;
+               case CS35L41_GPIO2_INT_PUSH_PULL_HIGH:
+                       irq_pol = IRQF_TRIGGER_HIGH;
+                       break;
+               default:
+                       break;
+               }
+       }
 
        return irq_pol;
 }
@@ -1121,14 +1129,20 @@ static int cs35l41_handle_pdata(struct device *dev, struct cs35l41_hw_cfg *hw_cf
        ret = device_property_read_u32(dev, "cirrus,boost-peak-milliamp", &val);
        if (ret >= 0)
                hw_cfg->bst_ipk = val;
+       else
+               hw_cfg->bst_ipk = -1;
 
        ret = device_property_read_u32(dev, "cirrus,boost-ind-nanohenry", &val);
        if (ret >= 0)
                hw_cfg->bst_ind = val;
+       else
+               hw_cfg->bst_ind = -1;
 
        ret = device_property_read_u32(dev, "cirrus,boost-cap-microfarad", &val);
        if (ret >= 0)
                hw_cfg->bst_cap = val;
+       else
+               hw_cfg->bst_cap = -1;
 
        ret = device_property_read_u32(dev, "cirrus,asp-sdout-hiz", &val);
        if (ret >= 0)
@@ -1140,15 +1154,21 @@ static int cs35l41_handle_pdata(struct device *dev, struct cs35l41_hw_cfg *hw_cf
        gpio1->pol_inv = device_property_read_bool(dev, "cirrus,gpio1-polarity-invert");
        gpio1->out_en = device_property_read_bool(dev, "cirrus,gpio1-output-enable");
        ret = device_property_read_u32(dev, "cirrus,gpio1-src-select", &val);
-       if (ret >= 0)
-               gpio1->func = val | CS35L41_VALID_PDATA;
+       if (ret >= 0) {
+               gpio1->func = val;
+               gpio1->valid = true;
+       }
 
        /* GPIO2 Pin Config */
        gpio2->pol_inv = device_property_read_bool(dev, "cirrus,gpio2-polarity-invert");
        gpio2->out_en = device_property_read_bool(dev, "cirrus,gpio2-output-enable");
        ret = device_property_read_u32(dev, "cirrus,gpio2-src-select", &val);
-       if (ret >= 0)
-               gpio2->func = val | CS35L41_VALID_PDATA;
+       if (ret >= 0) {
+               gpio2->func = val;
+               gpio2->valid = true;
+       }
+
+       hw_cfg->valid = true;
 
        return 0;
 }