1 // SPDX-License-Identifier: GPL-2.0
3 // CS35l41 ALSA HDA audio driver
5 // Copyright 2021 Cirrus Logic, Inc.
7 // Author: Lucas Tanure <tanureal@opensource.cirrus.com>
9 #include <linux/acpi.h>
10 #include <linux/module.h>
11 #include <sound/hda_codec.h>
12 #include "hda_local.h"
13 #include "hda_auto_parser.h"
15 #include "hda_generic.h"
16 #include "hda_component.h"
17 #include "cs35l41_hda.h"
19 static const struct reg_sequence cs35l41_hda_config[] = {
20 { CS35L41_PLL_CLK_CTRL, 0x00000430 }, // 3072000Hz, BCLK Input, PLL_REFCLK_EN = 1
21 { CS35L41_GLOBAL_CLK_CTRL, 0x00000003 }, // GLOBAL_FS = 48 kHz
22 { CS35L41_SP_ENABLES, 0x00010000 }, // ASP_RX1_EN = 1
23 { CS35L41_SP_RATE_CTRL, 0x00000021 }, // ASP_BCLK_FREQ = 3.072 MHz
24 { CS35L41_SP_FORMAT, 0x20200200 }, // 32 bits RX/TX slots, I2S, clk consumer
25 { CS35L41_DAC_PCM1_SRC, 0x00000008 }, // DACPCM1_SRC = ASPRX1
26 { CS35L41_AMP_DIG_VOL_CTRL, 0x00000000 }, // AMP_VOL_PCM 0.0 dB
27 { CS35L41_AMP_GAIN_CTRL, 0x00000084 }, // AMP_GAIN_PCM 4.5 dB
30 static const struct reg_sequence cs35l41_hda_mute[] = {
31 { CS35L41_AMP_GAIN_CTRL, 0x00000000 }, // AMP_GAIN_PCM 0.5 dB
32 { CS35L41_AMP_DIG_VOL_CTRL, 0x0000A678 }, // AMP_VOL_PCM Mute
35 /* Protection release cycle to get the speaker out of Safe-Mode */
36 static void cs35l41_error_release(struct device *dev, struct regmap *regmap, unsigned int mask)
38 regmap_write(regmap, CS35L41_PROTECT_REL_ERR_IGN, 0);
39 regmap_set_bits(regmap, CS35L41_PROTECT_REL_ERR_IGN, mask);
40 regmap_clear_bits(regmap, CS35L41_PROTECT_REL_ERR_IGN, mask);
43 /* Clear all errors to release safe mode. Global Enable must be cleared first. */
44 static void cs35l41_irq_release(struct cs35l41_hda *cs35l41)
46 cs35l41_error_release(cs35l41->dev, cs35l41->regmap, cs35l41->irq_errors);
47 cs35l41->irq_errors = 0;
50 static void cs35l41_hda_playback_hook(struct device *dev, int action)
52 struct cs35l41_hda *cs35l41 = dev_get_drvdata(dev);
53 struct regmap *reg = cs35l41->regmap;
57 case HDA_GEN_PCM_ACT_OPEN:
58 regmap_multi_reg_write(reg, cs35l41_hda_config, ARRAY_SIZE(cs35l41_hda_config));
59 ret = regmap_update_bits(reg, CS35L41_PWR_CTRL2,
60 CS35L41_AMP_EN_MASK, 1 << CS35L41_AMP_EN_SHIFT);
61 if (cs35l41->hw_cfg.bst_type == CS35L41_EXT_BOOST)
62 regmap_write(reg, CS35L41_GPIO1_CTRL1, 0x00008001);
64 case HDA_GEN_PCM_ACT_PREPARE:
65 ret = cs35l41_global_enable(reg, cs35l41->hw_cfg.bst_type, 1);
67 case HDA_GEN_PCM_ACT_CLEANUP:
68 regmap_multi_reg_write(reg, cs35l41_hda_mute, ARRAY_SIZE(cs35l41_hda_mute));
69 ret = cs35l41_global_enable(reg, cs35l41->hw_cfg.bst_type, 0);
71 case HDA_GEN_PCM_ACT_CLOSE:
72 ret = regmap_update_bits(reg, CS35L41_PWR_CTRL2,
73 CS35L41_AMP_EN_MASK, 0 << CS35L41_AMP_EN_SHIFT);
74 if (cs35l41->hw_cfg.bst_type == CS35L41_EXT_BOOST)
75 regmap_write(reg, CS35L41_GPIO1_CTRL1, 0x00000001);
76 cs35l41_irq_release(cs35l41);
79 dev_warn(cs35l41->dev, "Playback action not supported: %d\n", action);
84 dev_err(cs35l41->dev, "Regmap access fail: %d\n", ret);
87 static int cs35l41_hda_channel_map(struct device *dev, unsigned int tx_num, unsigned int *tx_slot,
88 unsigned int rx_num, unsigned int *rx_slot)
90 struct cs35l41_hda *cs35l41 = dev_get_drvdata(dev);
91 static const char * const channel_name[] = { "L", "R" };
93 if (!cs35l41->amp_name) {
94 if (*rx_slot >= ARRAY_SIZE(channel_name))
97 cs35l41->amp_name = devm_kasprintf(cs35l41->dev, GFP_KERNEL, "%s%d",
98 channel_name[*rx_slot], cs35l41->channel_index);
99 if (!cs35l41->amp_name)
103 return cs35l41_set_channels(cs35l41->dev, cs35l41->regmap, tx_num, tx_slot, rx_num,
107 static int cs35l41_hda_bind(struct device *dev, struct device *master, void *master_data)
109 struct cs35l41_hda *cs35l41 = dev_get_drvdata(dev);
110 struct hda_component *comps = master_data;
112 if (!comps || cs35l41->index < 0 || cs35l41->index >= HDA_MAX_COMPONENTS)
115 comps = &comps[cs35l41->index];
120 strscpy(comps->name, dev_name(dev), sizeof(comps->name));
121 comps->playback_hook = cs35l41_hda_playback_hook;
126 static void cs35l41_hda_unbind(struct device *dev, struct device *master, void *master_data)
128 struct cs35l41_hda *cs35l41 = dev_get_drvdata(dev);
129 struct hda_component *comps = master_data;
131 if (comps[cs35l41->index].dev == dev)
132 memset(&comps[cs35l41->index], 0, sizeof(*comps));
135 static const struct component_ops cs35l41_hda_comp_ops = {
136 .bind = cs35l41_hda_bind,
137 .unbind = cs35l41_hda_unbind,
140 static irqreturn_t cs35l41_bst_short_err(int irq, void *data)
142 struct cs35l41_hda *cs35l41 = data;
144 dev_crit_ratelimited(cs35l41->dev, "LBST Error\n");
145 set_bit(CS35L41_BST_SHORT_ERR_RLS_SHIFT, &cs35l41->irq_errors);
150 static irqreturn_t cs35l41_bst_dcm_uvp_err(int irq, void *data)
152 struct cs35l41_hda *cs35l41 = data;
154 dev_crit_ratelimited(cs35l41->dev, "DCM VBST Under Voltage Error\n");
155 set_bit(CS35L41_BST_UVP_ERR_RLS_SHIFT, &cs35l41->irq_errors);
160 static irqreturn_t cs35l41_bst_ovp_err(int irq, void *data)
162 struct cs35l41_hda *cs35l41 = data;
164 dev_crit_ratelimited(cs35l41->dev, "VBST Over Voltage error\n");
165 set_bit(CS35L41_BST_OVP_ERR_RLS_SHIFT, &cs35l41->irq_errors);
170 static irqreturn_t cs35l41_temp_err(int irq, void *data)
172 struct cs35l41_hda *cs35l41 = data;
174 dev_crit_ratelimited(cs35l41->dev, "Over temperature error\n");
175 set_bit(CS35L41_TEMP_ERR_RLS_SHIFT, &cs35l41->irq_errors);
180 static irqreturn_t cs35l41_temp_warn(int irq, void *data)
182 struct cs35l41_hda *cs35l41 = data;
184 dev_crit_ratelimited(cs35l41->dev, "Over temperature warning\n");
185 set_bit(CS35L41_TEMP_WARN_ERR_RLS_SHIFT, &cs35l41->irq_errors);
190 static irqreturn_t cs35l41_amp_short(int irq, void *data)
192 struct cs35l41_hda *cs35l41 = data;
194 dev_crit_ratelimited(cs35l41->dev, "Amp short error\n");
195 set_bit(CS35L41_AMP_SHORT_ERR_RLS_SHIFT, &cs35l41->irq_errors);
200 static const struct cs35l41_irq cs35l41_irqs[] = {
201 CS35L41_IRQ(BST_OVP_ERR, "Boost Overvoltage Error", cs35l41_bst_ovp_err),
202 CS35L41_IRQ(BST_DCM_UVP_ERR, "Boost Undervoltage Error", cs35l41_bst_dcm_uvp_err),
203 CS35L41_IRQ(BST_SHORT_ERR, "Boost Inductor Short Error", cs35l41_bst_short_err),
204 CS35L41_IRQ(TEMP_WARN, "Temperature Warning", cs35l41_temp_warn),
205 CS35L41_IRQ(TEMP_ERR, "Temperature Error", cs35l41_temp_err),
206 CS35L41_IRQ(AMP_SHORT_ERR, "Amp Short", cs35l41_amp_short),
209 static const struct regmap_irq cs35l41_reg_irqs[] = {
210 CS35L41_REG_IRQ(IRQ1_STATUS1, BST_OVP_ERR),
211 CS35L41_REG_IRQ(IRQ1_STATUS1, BST_DCM_UVP_ERR),
212 CS35L41_REG_IRQ(IRQ1_STATUS1, BST_SHORT_ERR),
213 CS35L41_REG_IRQ(IRQ1_STATUS1, TEMP_WARN),
214 CS35L41_REG_IRQ(IRQ1_STATUS1, TEMP_ERR),
215 CS35L41_REG_IRQ(IRQ1_STATUS1, AMP_SHORT_ERR),
218 static const struct regmap_irq_chip cs35l41_regmap_irq_chip = {
219 .name = "cs35l41 IRQ1 Controller",
220 .status_base = CS35L41_IRQ1_STATUS1,
221 .mask_base = CS35L41_IRQ1_MASK1,
222 .ack_base = CS35L41_IRQ1_STATUS1,
224 .irqs = cs35l41_reg_irqs,
225 .num_irqs = ARRAY_SIZE(cs35l41_reg_irqs),
228 static int cs35l41_hda_apply_properties(struct cs35l41_hda *cs35l41)
230 struct cs35l41_hw_cfg *hw_cfg = &cs35l41->hw_cfg;
231 bool using_irq = false;
236 if (!cs35l41->hw_cfg.valid)
239 ret = cs35l41_init_boost(cs35l41->dev, cs35l41->regmap, hw_cfg);
243 if (hw_cfg->gpio1.valid) {
244 switch (hw_cfg->gpio1.func) {
245 case CS35L41_NOT_USED:
247 case CS35l41_VSPK_SWITCH:
248 hw_cfg->gpio1.func = CS35L41_GPIO1_GPIO;
249 hw_cfg->gpio1.out_en = true;
252 hw_cfg->gpio1.func = CS35L41_GPIO1_MDSYNC;
255 dev_err(cs35l41->dev, "Invalid function %d for GPIO1\n",
261 if (hw_cfg->gpio2.valid) {
262 switch (hw_cfg->gpio2.func) {
263 case CS35L41_NOT_USED:
265 case CS35L41_INTERRUPT:
269 dev_err(cs35l41->dev, "Invalid GPIO2 function %d\n", hw_cfg->gpio2.func);
274 irq_pol = cs35l41_gpio_config(cs35l41->regmap, hw_cfg);
276 if (cs35l41->irq && using_irq) {
277 ret = devm_regmap_add_irq_chip(cs35l41->dev, cs35l41->regmap, cs35l41->irq,
278 IRQF_ONESHOT | IRQF_SHARED | irq_pol,
279 0, &cs35l41_regmap_irq_chip, &cs35l41->irq_data);
283 for (i = 0; i < ARRAY_SIZE(cs35l41_irqs); i++) {
284 irq = regmap_irq_get_virq(cs35l41->irq_data, cs35l41_irqs[i].irq);
288 ret = devm_request_threaded_irq(cs35l41->dev, irq, NULL,
289 cs35l41_irqs[i].handler,
290 IRQF_ONESHOT | IRQF_SHARED | irq_pol,
291 cs35l41_irqs[i].name, cs35l41);
297 return cs35l41_hda_channel_map(cs35l41->dev, 0, NULL, 1, &hw_cfg->spk_pos);
300 static int cs35l41_hda_read_acpi(struct cs35l41_hda *cs35l41, const char *hid, int id)
302 struct cs35l41_hw_cfg *hw_cfg = &cs35l41->hw_cfg;
303 u32 values[HDA_MAX_COMPONENTS];
304 struct acpi_device *adev;
305 struct device *physdev;
310 adev = acpi_dev_get_first_match_dev(hid, NULL, -1);
312 dev_err(cs35l41->dev, "Failed to find an ACPI device for %s\n", hid);
316 physdev = get_device(acpi_get_first_physical_node(adev));
319 property = "cirrus,dev-index";
320 ret = device_property_count_u32(physdev, property);
324 if (ret > ARRAY_SIZE(values)) {
330 ret = device_property_read_u32_array(physdev, property, values, nval);
335 for (i = 0; i < nval; i++) {
336 if (values[i] == id) {
341 if (cs35l41->index == -1) {
342 dev_err(cs35l41->dev, "No index found in %s\n", property);
347 /* To use the same release code for all laptop variants we can't use devm_ version of
348 * gpiod_get here, as CLSA010* don't have a fully functional bios with an _DSD node
350 cs35l41->reset_gpio = fwnode_gpiod_get_index(&adev->fwnode, "reset", cs35l41->index,
351 GPIOD_OUT_LOW, "cs35l41-reset");
353 property = "cirrus,speaker-position";
354 ret = device_property_read_u32_array(physdev, property, values, nval);
357 hw_cfg->spk_pos = values[cs35l41->index];
359 cs35l41->channel_index = 0;
360 for (i = 0; i < cs35l41->index; i++)
361 if (values[i] == hw_cfg->spk_pos)
362 cs35l41->channel_index++;
364 property = "cirrus,gpio1-func";
365 ret = device_property_read_u32_array(physdev, property, values, nval);
368 hw_cfg->gpio1.func = values[cs35l41->index];
369 hw_cfg->gpio1.valid = true;
371 property = "cirrus,gpio2-func";
372 ret = device_property_read_u32_array(physdev, property, values, nval);
375 hw_cfg->gpio2.func = values[cs35l41->index];
376 hw_cfg->gpio2.valid = true;
378 property = "cirrus,boost-peak-milliamp";
379 ret = device_property_read_u32_array(physdev, property, values, nval);
381 hw_cfg->bst_ipk = values[cs35l41->index];
383 hw_cfg->bst_ipk = -1;
385 property = "cirrus,boost-ind-nanohenry";
386 ret = device_property_read_u32_array(physdev, property, values, nval);
388 hw_cfg->bst_ind = values[cs35l41->index];
390 hw_cfg->bst_ind = -1;
392 property = "cirrus,boost-cap-microfarad";
393 ret = device_property_read_u32_array(physdev, property, values, nval);
395 hw_cfg->bst_cap = values[cs35l41->index];
397 hw_cfg->bst_cap = -1;
399 if (hw_cfg->bst_ind > 0 || hw_cfg->bst_cap > 0 || hw_cfg->bst_ipk > 0)
400 hw_cfg->bst_type = CS35L41_INT_BOOST;
402 hw_cfg->bst_type = CS35L41_EXT_BOOST;
404 hw_cfg->valid = true;
411 dev_err(cs35l41->dev, "Failed property %s: %d\n", property, ret);
417 * Device CLSA0100 doesn't have _DSD so a gpiod_get by the label reset won't work.
418 * And devices created by i2c-multi-instantiate don't have their device struct pointing to
419 * the correct fwnode, so acpi_dev must be used here.
420 * And devm functions expect that the device requesting the resource has the correct
423 if (strncmp(hid, "CLSA0100", 8) != 0)
426 /* check I2C address to assign the index */
427 cs35l41->index = id == 0x40 ? 0 : 1;
428 cs35l41->hw_cfg.spk_pos = cs35l41->index;
429 cs35l41->channel_index = 0;
430 cs35l41->reset_gpio = gpiod_get_index(physdev, NULL, 0, GPIOD_OUT_HIGH);
431 cs35l41->hw_cfg.bst_type = CS35L41_EXT_BOOST_NO_VSPK_SWITCH;
432 hw_cfg->gpio2.func = CS35L41_GPIO2_INT_OPEN_DRAIN;
433 hw_cfg->gpio2.valid = true;
434 cs35l41->hw_cfg.valid = true;
440 int cs35l41_hda_probe(struct device *dev, const char *device_name, int id, int irq,
441 struct regmap *regmap)
443 unsigned int int_sts, regid, reg_revid, mtl_revid, chipid, int_status;
444 struct cs35l41_hda *cs35l41;
447 BUILD_BUG_ON(ARRAY_SIZE(cs35l41_irqs) != ARRAY_SIZE(cs35l41_reg_irqs));
448 BUILD_BUG_ON(ARRAY_SIZE(cs35l41_irqs) != CS35L41_NUM_IRQ);
451 return PTR_ERR(regmap);
453 cs35l41 = devm_kzalloc(dev, sizeof(*cs35l41), GFP_KERNEL);
459 cs35l41->regmap = regmap;
460 dev_set_drvdata(dev, cs35l41);
462 ret = cs35l41_hda_read_acpi(cs35l41, device_name, id);
464 dev_err_probe(cs35l41->dev, ret, "Platform not supported %d\n", ret);
468 if (IS_ERR(cs35l41->reset_gpio)) {
469 ret = PTR_ERR(cs35l41->reset_gpio);
470 cs35l41->reset_gpio = NULL;
472 dev_info(cs35l41->dev, "Reset line busy, assuming shared reset\n");
474 dev_err_probe(cs35l41->dev, ret, "Failed to get reset GPIO: %d\n", ret);
478 if (cs35l41->reset_gpio) {
479 usleep_range(2000, 2100);
480 gpiod_set_value_cansleep(cs35l41->reset_gpio, 1);
483 usleep_range(2000, 2100);
485 ret = regmap_read_poll_timeout(cs35l41->regmap, CS35L41_IRQ1_STATUS4, int_status,
486 int_status & CS35L41_OTP_BOOT_DONE, 1000, 100000);
488 dev_err(cs35l41->dev, "Failed waiting for OTP_BOOT_DONE: %d\n", ret);
492 ret = regmap_read(cs35l41->regmap, CS35L41_IRQ1_STATUS3, &int_sts);
493 if (ret || (int_sts & CS35L41_OTP_BOOT_ERR)) {
494 dev_err(cs35l41->dev, "OTP Boot status %x error: %d\n",
495 int_sts & CS35L41_OTP_BOOT_ERR, ret);
500 ret = regmap_read(cs35l41->regmap, CS35L41_DEVID, ®id);
502 dev_err(cs35l41->dev, "Get Device ID failed: %d\n", ret);
506 ret = regmap_read(cs35l41->regmap, CS35L41_REVID, ®_revid);
508 dev_err(cs35l41->dev, "Get Revision ID failed: %d\n", ret);
512 mtl_revid = reg_revid & CS35L41_MTLREVID_MASK;
514 chipid = (mtl_revid % 2) ? CS35L41R_CHIP_ID : CS35L41_CHIP_ID;
515 if (regid != chipid) {
516 dev_err(cs35l41->dev, "CS35L41 Device ID (%X). Expected ID %X\n", regid, chipid);
521 ret = cs35l41_test_key_unlock(cs35l41->dev, cs35l41->regmap);
525 ret = cs35l41_register_errata_patch(cs35l41->dev, cs35l41->regmap, reg_revid);
529 ret = cs35l41_otp_unpack(cs35l41->dev, cs35l41->regmap);
531 dev_err(cs35l41->dev, "OTP Unpack failed: %d\n", ret);
535 ret = cs35l41_test_key_lock(cs35l41->dev, cs35l41->regmap);
539 ret = cs35l41_hda_apply_properties(cs35l41);
543 ret = component_add(cs35l41->dev, &cs35l41_hda_comp_ops);
545 dev_err(cs35l41->dev, "Register component failed: %d\n", ret);
549 dev_info(cs35l41->dev, "Cirrus Logic CS35L41 (%x), Revision: %02X\n", regid, reg_revid);
554 if (cs35l41_safe_reset(cs35l41->regmap, cs35l41->hw_cfg.bst_type))
555 gpiod_set_value_cansleep(cs35l41->reset_gpio, 0);
556 gpiod_put(cs35l41->reset_gpio);
560 EXPORT_SYMBOL_NS_GPL(cs35l41_hda_probe, SND_HDA_SCODEC_CS35L41);
562 void cs35l41_hda_remove(struct device *dev)
564 struct cs35l41_hda *cs35l41 = dev_get_drvdata(dev);
566 component_del(cs35l41->dev, &cs35l41_hda_comp_ops);
568 if (cs35l41_safe_reset(cs35l41->regmap, cs35l41->hw_cfg.bst_type))
569 gpiod_set_value_cansleep(cs35l41->reset_gpio, 0);
570 gpiod_put(cs35l41->reset_gpio);
572 EXPORT_SYMBOL_NS_GPL(cs35l41_hda_remove, SND_HDA_SCODEC_CS35L41);
574 MODULE_DESCRIPTION("CS35L41 HDA Driver");
575 MODULE_AUTHOR("Lucas Tanure, Cirrus Logic Inc, <tanureal@opensource.cirrus.com>");
576 MODULE_LICENSE("GPL");