1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * HD audio interface patch for Cirrus Logic CS8409 HDA bridge chip
5 * Copyright (C) 2021 Cirrus Logic, Inc. and
6 * Cirrus Logic International Semiconductor Ltd.
9 #include <linux/init.h>
10 #include <linux/slab.h>
11 #include <linux/module.h>
12 #include <sound/core.h>
13 #include <linux/mutex.h>
14 #include <linux/iopoll.h>
16 #include "patch_cs8409.h"
18 /******************************************************************************
19 * CS8409 Specific Functions
20 ******************************************************************************/
22 static int cs8409_parse_auto_config(struct hda_codec *codec)
24 struct cs8409_spec *spec = codec->spec;
28 err = snd_hda_parse_pin_defcfg(codec, &spec->gen.autocfg, NULL, 0);
32 err = snd_hda_gen_parse_auto_config(codec, &spec->gen.autocfg);
36 /* keep the ADCs powered up when it's dynamically switchable */
37 if (spec->gen.dyn_adc_switch) {
38 unsigned int done = 0;
40 for (i = 0; i < spec->gen.input_mux.num_items; i++) {
41 int idx = spec->gen.dyn_adc_idx[i];
43 if (done & (1 << idx))
45 snd_hda_gen_fix_pin_power(codec, spec->gen.adc_nids[idx]);
53 static void cs8409_disable_i2c_clock_worker(struct work_struct *work);
55 static struct cs8409_spec *cs8409_alloc_spec(struct hda_codec *codec)
57 struct cs8409_spec *spec;
59 spec = kzalloc(sizeof(*spec), GFP_KERNEL);
64 codec->power_save_node = 1;
65 mutex_init(&spec->i2c_mux);
66 INIT_DELAYED_WORK(&spec->i2c_clk_work, cs8409_disable_i2c_clock_worker);
67 snd_hda_gen_spec_init(&spec->gen);
72 static inline int cs8409_vendor_coef_get(struct hda_codec *codec, unsigned int idx)
74 snd_hda_codec_write(codec, CS8409_PIN_VENDOR_WIDGET, 0, AC_VERB_SET_COEF_INDEX, idx);
75 return snd_hda_codec_read(codec, CS8409_PIN_VENDOR_WIDGET, 0, AC_VERB_GET_PROC_COEF, 0);
78 static inline void cs8409_vendor_coef_set(struct hda_codec *codec, unsigned int idx,
81 snd_hda_codec_write(codec, CS8409_PIN_VENDOR_WIDGET, 0, AC_VERB_SET_COEF_INDEX, idx);
82 snd_hda_codec_write(codec, CS8409_PIN_VENDOR_WIDGET, 0, AC_VERB_SET_PROC_COEF, coef);
86 * cs8409_enable_i2c_clock - Disable I2C clocks
87 * @codec: the codec instance
89 * This must be called when the i2c mutex is unlocked.
91 static void cs8409_disable_i2c_clock(struct hda_codec *codec)
93 struct cs8409_spec *spec = codec->spec;
95 mutex_lock(&spec->i2c_mux);
96 if (spec->i2c_clck_enabled) {
97 cs8409_vendor_coef_set(spec->codec, 0x0,
98 cs8409_vendor_coef_get(spec->codec, 0x0) & 0xfffffff7);
99 spec->i2c_clck_enabled = 0;
101 mutex_unlock(&spec->i2c_mux);
105 * cs8409_disable_i2c_clock_worker - Worker that disable the I2C Clock after 25ms without use
107 static void cs8409_disable_i2c_clock_worker(struct work_struct *work)
109 struct cs8409_spec *spec = container_of(work, struct cs8409_spec, i2c_clk_work.work);
111 cs8409_disable_i2c_clock(spec->codec);
115 * cs8409_enable_i2c_clock - Enable I2C clocks
116 * @codec: the codec instance
118 * This must be called when the i2c mutex is locked.
120 static void cs8409_enable_i2c_clock(struct hda_codec *codec)
122 struct cs8409_spec *spec = codec->spec;
124 /* Cancel the disable timer, but do not wait for any running disable functions to finish.
125 * If the disable timer runs out before cancel, the delayed work thread will be blocked,
126 * waiting for the mutex to become unlocked. This mutex will be locked for the duration of
127 * any i2c transaction, so the disable function will run to completion immediately
128 * afterwards in the scenario. The next enable call will re-enable the clock, regardless.
130 cancel_delayed_work(&spec->i2c_clk_work);
132 if (!spec->i2c_clck_enabled) {
133 cs8409_vendor_coef_set(codec, 0x0, cs8409_vendor_coef_get(codec, 0x0) | 0x8);
134 spec->i2c_clck_enabled = 1;
136 queue_delayed_work(system_power_efficient_wq, &spec->i2c_clk_work, msecs_to_jiffies(25));
140 * cs8409_i2c_wait_complete - Wait for I2C transaction
141 * @codec: the codec instance
143 * Wait for I2C transaction to complete.
144 * Return -ETIMEDOUT if transaction wait times out.
146 static int cs8409_i2c_wait_complete(struct hda_codec *codec)
150 return read_poll_timeout(cs8409_vendor_coef_get, retval, retval & 0x18,
151 CS42L42_I2C_SLEEP_US, CS42L42_I2C_TIMEOUT_US, false, codec, CS8409_I2C_STS);
155 * cs8409_set_i2c_dev_addr - Set i2c address for transaction
156 * @codec: the codec instance
159 static void cs8409_set_i2c_dev_addr(struct hda_codec *codec, unsigned int addr)
161 struct cs8409_spec *spec = codec->spec;
163 if (spec->dev_addr != addr) {
164 cs8409_vendor_coef_set(codec, CS8409_I2C_ADDR, addr);
165 spec->dev_addr = addr;
170 * cs8409_i2c_set_page - CS8409 I2C set page register.
171 * @scodec: the codec instance
172 * @i2c_reg: Page register
174 * Returns negative on error.
176 static int cs8409_i2c_set_page(struct sub_codec *scodec, unsigned int i2c_reg)
178 struct hda_codec *codec = scodec->codec;
180 if (scodec->paged && (scodec->last_page != (i2c_reg >> 8))) {
181 cs8409_vendor_coef_set(codec, CS8409_I2C_QWRITE, i2c_reg >> 8);
182 if (cs8409_i2c_wait_complete(codec) < 0)
184 scodec->last_page = i2c_reg >> 8;
191 * cs8409_i2c_read - CS8409 I2C Read.
192 * @scodec: the codec instance
193 * @addr: Register to read
195 * Returns negative on error, otherwise returns read value in bits 0-7.
197 static int cs8409_i2c_read(struct sub_codec *scodec, unsigned int addr)
199 struct hda_codec *codec = scodec->codec;
200 struct cs8409_spec *spec = codec->spec;
201 unsigned int i2c_reg_data;
202 unsigned int read_data;
204 if (scodec->suspended)
207 mutex_lock(&spec->i2c_mux);
208 cs8409_enable_i2c_clock(codec);
209 cs8409_set_i2c_dev_addr(codec, scodec->addr);
211 if (cs8409_i2c_set_page(scodec, addr))
214 i2c_reg_data = (addr << 8) & 0x0ffff;
215 cs8409_vendor_coef_set(codec, CS8409_I2C_QREAD, i2c_reg_data);
216 if (cs8409_i2c_wait_complete(codec) < 0)
219 /* Register in bits 15-8 and the data in 7-0 */
220 read_data = cs8409_vendor_coef_get(codec, CS8409_I2C_QREAD);
222 mutex_unlock(&spec->i2c_mux);
224 return read_data & 0x0ff;
227 mutex_unlock(&spec->i2c_mux);
228 codec_err(codec, "%s() Failed 0x%02x : 0x%04x\n", __func__, scodec->addr, addr);
233 * cs8409_i2c_bulk_read - CS8409 I2C Read Sequence.
234 * @scodec: the codec instance
235 * @seq: Register Sequence to read
236 * @count: Number of registeres to read
238 * Returns negative on error, values are read into value element of cs8409_i2c_param sequence.
240 static int cs8409_i2c_bulk_read(struct sub_codec *scodec, struct cs8409_i2c_param *seq, int count)
242 struct hda_codec *codec = scodec->codec;
243 struct cs8409_spec *spec = codec->spec;
244 unsigned int i2c_reg_data;
247 if (scodec->suspended)
250 mutex_lock(&spec->i2c_mux);
251 cs8409_set_i2c_dev_addr(codec, scodec->addr);
253 for (i = 0; i < count; i++) {
254 cs8409_enable_i2c_clock(codec);
255 if (cs8409_i2c_set_page(scodec, seq[i].addr))
258 i2c_reg_data = (seq[i].addr << 8) & 0x0ffff;
259 cs8409_vendor_coef_set(codec, CS8409_I2C_QREAD, i2c_reg_data);
261 if (cs8409_i2c_wait_complete(codec) < 0)
264 seq[i].value = cs8409_vendor_coef_get(codec, CS8409_I2C_QREAD) & 0xff;
267 mutex_unlock(&spec->i2c_mux);
272 mutex_unlock(&spec->i2c_mux);
273 codec_err(codec, "I2C Bulk Write Failed 0x%02x\n", scodec->addr);
278 * cs8409_i2c_write - CS8409 I2C Write.
279 * @scodec: the codec instance
280 * @addr: Register to write to
281 * @value: Data to write
283 * Returns negative on error, otherwise returns 0.
285 static int cs8409_i2c_write(struct sub_codec *scodec, unsigned int addr, unsigned int value)
287 struct hda_codec *codec = scodec->codec;
288 struct cs8409_spec *spec = codec->spec;
289 unsigned int i2c_reg_data;
291 if (scodec->suspended)
294 mutex_lock(&spec->i2c_mux);
296 cs8409_enable_i2c_clock(codec);
297 cs8409_set_i2c_dev_addr(codec, scodec->addr);
299 if (cs8409_i2c_set_page(scodec, addr))
302 i2c_reg_data = ((addr << 8) & 0x0ff00) | (value & 0x0ff);
303 cs8409_vendor_coef_set(codec, CS8409_I2C_QWRITE, i2c_reg_data);
305 if (cs8409_i2c_wait_complete(codec) < 0)
308 mutex_unlock(&spec->i2c_mux);
312 mutex_unlock(&spec->i2c_mux);
313 codec_err(codec, "%s() Failed 0x%02x : 0x%04x\n", __func__, scodec->addr, addr);
318 * cs8409_i2c_bulk_write - CS8409 I2C Write Sequence.
319 * @scodec: the codec instance
320 * @seq: Register Sequence to write
321 * @count: Number of registeres to write
323 * Returns negative on error.
325 static int cs8409_i2c_bulk_write(struct sub_codec *scodec, const struct cs8409_i2c_param *seq,
328 struct hda_codec *codec = scodec->codec;
329 struct cs8409_spec *spec = codec->spec;
330 unsigned int i2c_reg_data;
333 if (scodec->suspended)
336 mutex_lock(&spec->i2c_mux);
337 cs8409_set_i2c_dev_addr(codec, scodec->addr);
339 for (i = 0; i < count; i++) {
340 cs8409_enable_i2c_clock(codec);
341 if (cs8409_i2c_set_page(scodec, seq[i].addr))
344 i2c_reg_data = ((seq[i].addr << 8) & 0x0ff00) | (seq[i].value & 0x0ff);
345 cs8409_vendor_coef_set(codec, CS8409_I2C_QWRITE, i2c_reg_data);
347 if (cs8409_i2c_wait_complete(codec) < 0)
351 mutex_unlock(&spec->i2c_mux);
356 mutex_unlock(&spec->i2c_mux);
357 codec_err(codec, "I2C Bulk Write Failed 0x%02x\n", scodec->addr);
361 static int cs8409_init(struct hda_codec *codec)
363 int ret = snd_hda_gen_init(codec);
366 snd_hda_apply_fixup(codec, HDA_FIXUP_ACT_INIT);
371 static int cs8409_build_controls(struct hda_codec *codec)
375 err = snd_hda_gen_build_controls(codec);
378 snd_hda_apply_fixup(codec, HDA_FIXUP_ACT_BUILD);
383 /* Enable/Disable Unsolicited Response */
384 static void cs8409_enable_ur(struct hda_codec *codec, int flag)
386 struct cs8409_spec *spec = codec->spec;
387 unsigned int ur_gpios = 0;
390 for (i = 0; i < spec->num_scodecs; i++)
391 ur_gpios |= spec->scodecs[i]->irq_mask;
393 snd_hda_codec_write(codec, CS8409_PIN_AFG, 0, AC_VERB_SET_GPIO_UNSOLICITED_RSP_MASK,
394 flag ? ur_gpios : 0);
396 snd_hda_codec_write(codec, CS8409_PIN_AFG, 0, AC_VERB_SET_UNSOLICITED_ENABLE,
397 flag ? AC_UNSOL_ENABLED : 0);
400 static void cs8409_fix_caps(struct hda_codec *codec, unsigned int nid)
404 /* CS8409 is simple HDA bridge and intended to be used with a remote
405 * companion codec. Most of input/output PIN(s) have only basic
406 * capabilities. Receive and Transmit NID(s) have only OUTC and INC
407 * capabilities and no presence detect capable (PDC) and call to
408 * snd_hda_gen_build_controls() will mark them as non detectable
409 * phantom jacks. However, a companion codec may be
410 * connected to these pins which supports jack detect
411 * capabilities. We have to override pin capabilities,
412 * otherwise they will not be created as input devices.
414 caps = snd_hdac_read_parm(&codec->core, nid, AC_PAR_PIN_CAP);
416 snd_hdac_override_parm(&codec->core, nid, AC_PAR_PIN_CAP,
417 (caps | (AC_PINCAP_IMP_SENSE | AC_PINCAP_PRES_DETECT)));
419 snd_hda_override_wcaps(codec, nid, (get_wcaps(codec, nid) | AC_WCAP_UNSOL_CAP));
422 /******************************************************************************
423 * CS42L42 Specific Functions
424 ******************************************************************************/
426 int cs42l42_volume_info(struct snd_kcontrol *kctrl, struct snd_ctl_elem_info *uinfo)
428 unsigned int ofs = get_amp_offset(kctrl);
429 u8 chs = get_amp_channels(kctrl);
431 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
432 uinfo->value.integer.step = 1;
433 uinfo->count = chs == 3 ? 2 : 1;
436 case CS42L42_VOL_DAC:
437 uinfo->value.integer.min = CS42L42_HP_VOL_REAL_MIN;
438 uinfo->value.integer.max = CS42L42_HP_VOL_REAL_MAX;
440 case CS42L42_VOL_ADC:
441 uinfo->value.integer.min = CS42L42_AMIC_VOL_REAL_MIN;
442 uinfo->value.integer.max = CS42L42_AMIC_VOL_REAL_MAX;
451 int cs42l42_volume_get(struct snd_kcontrol *kctrl, struct snd_ctl_elem_value *uctrl)
453 struct hda_codec *codec = snd_kcontrol_chip(kctrl);
454 struct cs8409_spec *spec = codec->spec;
455 struct sub_codec *cs42l42 = spec->scodecs[get_amp_index(kctrl)];
456 int chs = get_amp_channels(kctrl);
457 unsigned int ofs = get_amp_offset(kctrl);
458 long *valp = uctrl->value.integer.value;
461 case CS42L42_VOL_DAC:
463 *valp++ = cs42l42->vol[ofs];
465 *valp = cs42l42->vol[ofs+1];
467 case CS42L42_VOL_ADC:
469 *valp = cs42l42->vol[ofs];
478 static void cs42l42_mute(struct sub_codec *cs42l42, int vol_type,
479 unsigned int chs, bool mute)
482 if (vol_type == CS42L42_VOL_DAC) {
484 cs8409_i2c_write(cs42l42, CS42L42_REG_HS_VOL_CHA, 0x3f);
486 cs8409_i2c_write(cs42l42, CS42L42_REG_HS_VOL_CHB, 0x3f);
487 } else if (vol_type == CS42L42_VOL_ADC) {
489 cs8409_i2c_write(cs42l42, CS42L42_REG_AMIC_VOL, 0x9f);
492 if (vol_type == CS42L42_VOL_DAC) {
494 cs8409_i2c_write(cs42l42, CS42L42_REG_HS_VOL_CHA,
495 -(cs42l42->vol[CS42L42_DAC_CH0_VOL_OFFSET])
496 & CS42L42_REG_HS_VOL_MASK);
498 cs8409_i2c_write(cs42l42, CS42L42_REG_HS_VOL_CHB,
499 -(cs42l42->vol[CS42L42_DAC_CH1_VOL_OFFSET])
500 & CS42L42_REG_HS_VOL_MASK);
501 } else if (vol_type == CS42L42_VOL_ADC) {
503 cs8409_i2c_write(cs42l42, CS42L42_REG_AMIC_VOL,
504 cs42l42->vol[CS42L42_ADC_VOL_OFFSET]
505 & CS42L42_REG_AMIC_VOL_MASK);
510 int cs42l42_volume_put(struct snd_kcontrol *kctrl, struct snd_ctl_elem_value *uctrl)
512 struct hda_codec *codec = snd_kcontrol_chip(kctrl);
513 struct cs8409_spec *spec = codec->spec;
514 struct sub_codec *cs42l42 = spec->scodecs[get_amp_index(kctrl)];
515 int chs = get_amp_channels(kctrl);
516 unsigned int ofs = get_amp_offset(kctrl);
517 long *valp = uctrl->value.integer.value;
520 case CS42L42_VOL_DAC:
522 cs42l42->vol[ofs] = *valp;
525 cs42l42->vol[ofs + 1] = *valp;
527 if (spec->playback_started)
528 cs42l42_mute(cs42l42, CS42L42_VOL_DAC, chs, false);
530 case CS42L42_VOL_ADC:
532 cs42l42->vol[ofs] = *valp;
533 if (spec->capture_started)
534 cs42l42_mute(cs42l42, CS42L42_VOL_ADC, chs, false);
543 static void cs42l42_playback_pcm_hook(struct hda_pcm_stream *hinfo,
544 struct hda_codec *codec,
545 struct snd_pcm_substream *substream,
548 struct cs8409_spec *spec = codec->spec;
549 struct sub_codec *cs42l42;
554 case HDA_GEN_PCM_ACT_PREPARE:
556 spec->playback_started = 1;
558 case HDA_GEN_PCM_ACT_CLEANUP:
560 spec->playback_started = 0;
566 for (i = 0; i < spec->num_scodecs; i++) {
567 cs42l42 = spec->scodecs[i];
568 cs42l42_mute(cs42l42, CS42L42_VOL_DAC, 0x3, mute);
572 static void cs42l42_capture_pcm_hook(struct hda_pcm_stream *hinfo,
573 struct hda_codec *codec,
574 struct snd_pcm_substream *substream,
577 struct cs8409_spec *spec = codec->spec;
578 struct sub_codec *cs42l42;
583 case HDA_GEN_PCM_ACT_PREPARE:
585 spec->capture_started = 1;
587 case HDA_GEN_PCM_ACT_CLEANUP:
589 spec->capture_started = 0;
595 for (i = 0; i < spec->num_scodecs; i++) {
596 cs42l42 = spec->scodecs[i];
597 cs42l42_mute(cs42l42, CS42L42_VOL_ADC, 0x3, mute);
601 /* Configure CS42L42 slave codec for jack autodetect */
602 static void cs42l42_enable_jack_detect(struct sub_codec *cs42l42)
604 cs8409_i2c_write(cs42l42, 0x1b70, cs42l42->hsbias_hiz);
606 cs8409_i2c_write(cs42l42, 0x1b71, 0x00C1);
608 usleep_range(2500, 3000);
609 /* Set mode WAKE# output follows the combination logic directly */
610 cs8409_i2c_write(cs42l42, 0x1b71, 0x00C0);
611 /* Clear interrupts status */
612 cs8409_i2c_read(cs42l42, 0x130f);
613 /* Enable interrupt */
614 cs8409_i2c_write(cs42l42, 0x1320, 0xF3);
617 /* Enable and run CS42L42 slave codec jack auto detect */
618 static void cs42l42_run_jack_detect(struct sub_codec *cs42l42)
620 /* Clear interrupts */
621 cs8409_i2c_read(cs42l42, 0x1308);
622 cs8409_i2c_read(cs42l42, 0x1b77);
623 cs8409_i2c_write(cs42l42, 0x1320, 0xFF);
624 cs8409_i2c_read(cs42l42, 0x130f);
626 cs8409_i2c_write(cs42l42, 0x1102, 0x87);
627 cs8409_i2c_write(cs42l42, 0x1f06, 0x86);
628 cs8409_i2c_write(cs42l42, 0x1b74, 0x07);
629 cs8409_i2c_write(cs42l42, 0x131b, 0xFD);
630 cs8409_i2c_write(cs42l42, 0x1120, 0x80);
632 usleep_range(20000, 25000);
633 cs8409_i2c_write(cs42l42, 0x111f, 0x77);
634 cs8409_i2c_write(cs42l42, 0x1120, 0xc0);
637 static int cs42l42_handle_tip_sense(struct sub_codec *cs42l42, unsigned int reg_ts_status)
639 int status_changed = cs42l42->force_status_change;
641 cs42l42->force_status_change = 0;
643 /* TIP_SENSE INSERT/REMOVE */
644 switch (reg_ts_status) {
645 case CS42L42_JACK_INSERTED:
646 if (!cs42l42->hp_jack_in) {
647 if (cs42l42->no_type_dect) {
649 cs42l42->hp_jack_in = 1;
650 cs42l42->mic_jack_in = 0;
652 cs42l42_run_jack_detect(cs42l42);
657 case CS42L42_JACK_REMOVED:
658 if (cs42l42->hp_jack_in || cs42l42->mic_jack_in) {
660 cs42l42->hp_jack_in = 0;
661 cs42l42->mic_jack_in = 0;
665 /* jack in transition */
669 return status_changed;
672 static int cs42l42_jack_unsol_event(struct sub_codec *cs42l42)
674 int status_changed = 0;
680 /* Read jack detect status registers */
681 reg_cdc_status = cs8409_i2c_read(cs42l42, 0x1308);
682 reg_hs_status = cs8409_i2c_read(cs42l42, 0x1124);
683 reg_ts_status = cs8409_i2c_read(cs42l42, 0x130f);
685 /* If status values are < 0, read error has occurred. */
686 if (reg_cdc_status < 0 || reg_hs_status < 0 || reg_ts_status < 0)
689 /* HSDET_AUTO_DONE */
690 if (reg_cdc_status & CS42L42_HSDET_AUTO_DONE) {
692 /* Disable HSDET_AUTO_DONE */
693 cs8409_i2c_write(cs42l42, 0x131b, 0xFF);
695 type = ((reg_hs_status & CS42L42_HSTYPE_MASK) + 1);
697 if (cs42l42->no_type_dect) {
698 status_changed = cs42l42_handle_tip_sense(cs42l42, reg_ts_status);
699 } else if (type == 4) {
700 /* Type 4 not supported */
701 status_changed = cs42l42_handle_tip_sense(cs42l42, CS42L42_JACK_REMOVED);
703 if (!cs42l42->hp_jack_in) {
705 cs42l42->hp_jack_in = 1;
707 /* type = 3 has no mic */
708 if ((!cs42l42->mic_jack_in) && (type != 3)) {
710 cs42l42->mic_jack_in = 1;
713 /* Configure the HSDET mode. */
714 cs8409_i2c_write(cs42l42, 0x1120, 0x80);
715 /* Enable the HPOUT ground clamp and configure the HP pull-down */
716 cs8409_i2c_write(cs42l42, 0x1F06, 0x02);
717 /* Re-Enable Tip Sense Interrupt */
718 cs8409_i2c_write(cs42l42, 0x1320, 0xF3);
720 status_changed = cs42l42_handle_tip_sense(cs42l42, reg_ts_status);
723 return status_changed;
726 static void cs42l42_resume(struct sub_codec *cs42l42)
728 struct hda_codec *codec = cs42l42->codec;
729 unsigned int gpio_data;
730 struct cs8409_i2c_param irq_regs[] = {
736 int fsv_old, fsv_new;
738 /* Bring CS42L42 out of Reset */
739 gpio_data = snd_hda_codec_read(codec, CS8409_PIN_AFG, 0, AC_VERB_GET_GPIO_DATA, 0);
740 gpio_data |= cs42l42->reset_gpio;
741 snd_hda_codec_write(codec, CS8409_PIN_AFG, 0, AC_VERB_SET_GPIO_DATA, gpio_data);
742 usleep_range(10000, 15000);
744 cs42l42->suspended = 0;
746 /* Initialize CS42L42 companion codec */
747 cs8409_i2c_bulk_write(cs42l42, cs42l42->init_seq, cs42l42->init_seq_num);
748 usleep_range(20000, 25000);
750 /* Clear interrupts, by reading interrupt status registers */
751 cs8409_i2c_bulk_read(cs42l42, irq_regs, ARRAY_SIZE(irq_regs));
753 fsv_old = cs8409_i2c_read(cs42l42, 0x2001);
754 if (cs42l42->full_scale_vol == CS42L42_FULL_SCALE_VOL_0DB)
755 fsv_new = fsv_old & ~CS42L42_FULL_SCALE_VOL_MASK;
757 fsv_new = fsv_old & CS42L42_FULL_SCALE_VOL_MASK;
758 if (fsv_new != fsv_old)
759 cs8409_i2c_write(cs42l42, 0x2001, fsv_new);
761 /* we have to explicitly allow unsol event handling even during the
762 * resume phase so that the jack event is processed properly
764 snd_hda_codec_allow_unsol_events(cs42l42->codec);
766 cs42l42_enable_jack_detect(cs42l42);
770 static void cs42l42_suspend(struct sub_codec *cs42l42)
772 struct hda_codec *codec = cs42l42->codec;
773 unsigned int gpio_data;
774 int reg_cdc_status = 0;
775 const struct cs8409_i2c_param cs42l42_pwr_down_seq[] = {
789 cs8409_i2c_bulk_write(cs42l42, cs42l42_pwr_down_seq, ARRAY_SIZE(cs42l42_pwr_down_seq));
791 if (read_poll_timeout(cs8409_i2c_read, reg_cdc_status,
792 (reg_cdc_status & 0x1), CS42L42_PDN_SLEEP_US, CS42L42_PDN_TIMEOUT_US,
793 true, cs42l42, 0x1308) < 0)
794 codec_warn(codec, "Timeout waiting for PDN_DONE for CS42L42\n");
796 /* Power down CS42L42 ASP/EQ/MIX/HP */
797 cs8409_i2c_write(cs42l42, 0x1102, 0x9C);
798 cs42l42->suspended = 1;
799 cs42l42->last_page = 0;
800 cs42l42->hp_jack_in = 0;
801 cs42l42->mic_jack_in = 0;
802 cs42l42->force_status_change = 1;
804 /* Put CS42L42 into Reset */
805 gpio_data = snd_hda_codec_read(codec, CS8409_PIN_AFG, 0, AC_VERB_GET_GPIO_DATA, 0);
806 gpio_data &= ~cs42l42->reset_gpio;
807 snd_hda_codec_write(codec, CS8409_PIN_AFG, 0, AC_VERB_SET_GPIO_DATA, gpio_data);
811 static void cs8409_free(struct hda_codec *codec)
813 struct cs8409_spec *spec = codec->spec;
815 /* Cancel i2c clock disable timer, and disable clock if left enabled */
816 cancel_delayed_work_sync(&spec->i2c_clk_work);
817 cs8409_disable_i2c_clock(codec);
819 snd_hda_gen_free(codec);
822 /******************************************************************************
823 * BULLSEYE / WARLOCK / CYBORG Specific Functions
825 ******************************************************************************/
828 * In the case of CS8409 we do not have unsolicited events from NID's 0x24
829 * and 0x34 where hs mic and hp are connected. Companion codec CS42L42 will
830 * generate interrupt via gpio 4 to notify jack events. We have to overwrite
831 * generic snd_hda_jack_unsol_event(), read CS42L42 jack detect status registers
832 * and then notify status via generic snd_hda_jack_unsol_event() call.
834 static void cs8409_cs42l42_jack_unsol_event(struct hda_codec *codec, unsigned int res)
836 struct cs8409_spec *spec = codec->spec;
837 struct sub_codec *cs42l42 = spec->scodecs[CS8409_CODEC0];
838 struct hda_jack_tbl *jk;
840 /* jack_unsol_event() will be called every time gpio line changing state.
841 * In this case gpio4 line goes up as a result of reading interrupt status
842 * registers in previous cs8409_jack_unsol_event() call.
843 * We don't need to handle this event, ignoring...
845 if (res & cs42l42->irq_mask)
848 if (cs42l42_jack_unsol_event(cs42l42)) {
849 snd_hda_set_pin_ctl(codec, CS8409_CS42L42_SPK_PIN_NID,
850 cs42l42->hp_jack_in ? 0 : PIN_OUT);
852 jk = snd_hda_jack_tbl_get_mst(codec, CS8409_CS42L42_HP_PIN_NID, 0);
854 snd_hda_jack_unsol_event(codec, (jk->tag << AC_UNSOL_RES_TAG_SHIFT) &
857 jk = snd_hda_jack_tbl_get_mst(codec, CS8409_CS42L42_AMIC_PIN_NID, 0);
859 snd_hda_jack_unsol_event(codec, (jk->tag << AC_UNSOL_RES_TAG_SHIFT) &
865 /* Manage PDREF, when transition to D3hot */
866 static int cs8409_cs42l42_suspend(struct hda_codec *codec)
868 struct cs8409_spec *spec = codec->spec;
873 cs8409_enable_ur(codec, 0);
875 for (i = 0; i < spec->num_scodecs; i++)
876 cs42l42_suspend(spec->scodecs[i]);
878 /* Cancel i2c clock disable timer, and disable clock if left enabled */
879 cancel_delayed_work_sync(&spec->i2c_clk_work);
880 cs8409_disable_i2c_clock(codec);
882 snd_hda_shutup_pins(codec);
888 /* Vendor specific HW configuration
889 * PLL, ASP, I2C, SPI, GPIOs, DMIC etc...
891 static void cs8409_cs42l42_hw_init(struct hda_codec *codec)
893 const struct cs8409_cir_param *seq = cs8409_cs42l42_hw_cfg;
894 const struct cs8409_cir_param *seq_bullseye = cs8409_cs42l42_bullseye_atn;
895 struct cs8409_spec *spec = codec->spec;
896 struct sub_codec *cs42l42 = spec->scodecs[CS8409_CODEC0];
898 if (spec->gpio_mask) {
899 snd_hda_codec_write(codec, CS8409_PIN_AFG, 0, AC_VERB_SET_GPIO_MASK,
901 snd_hda_codec_write(codec, CS8409_PIN_AFG, 0, AC_VERB_SET_GPIO_DIRECTION,
903 snd_hda_codec_write(codec, CS8409_PIN_AFG, 0, AC_VERB_SET_GPIO_DATA,
907 for (; seq->nid; seq++)
908 cs8409_vendor_coef_set(codec, seq->cir, seq->coeff);
910 if (codec->fixup_id == CS8409_BULLSEYE) {
911 for (; seq_bullseye->nid; seq_bullseye++)
912 cs8409_vendor_coef_set(codec, seq_bullseye->cir, seq_bullseye->coeff);
915 switch (codec->fixup_id) {
917 case CS8409_WARLOCK_MLK_DUAL_MIC:
918 /* DMIC1_MO=00b, DMIC1/2_SR=1 */
919 cs8409_vendor_coef_set(codec, CS8409_DMIC_CFG, 0x0003);
925 cs42l42_resume(cs42l42);
927 /* Enable Unsolicited Response */
928 cs8409_enable_ur(codec, 1);
931 static const struct hda_codec_ops cs8409_cs42l42_patch_ops = {
932 .build_controls = cs8409_build_controls,
933 .build_pcms = snd_hda_gen_build_pcms,
936 .unsol_event = cs8409_cs42l42_jack_unsol_event,
938 .suspend = cs8409_cs42l42_suspend,
942 static int cs8409_cs42l42_exec_verb(struct hdac_device *dev, unsigned int cmd, unsigned int flags,
945 struct hda_codec *codec = container_of(dev, struct hda_codec, core);
946 struct cs8409_spec *spec = codec->spec;
947 struct sub_codec *cs42l42 = spec->scodecs[CS8409_CODEC0];
949 unsigned int nid = ((cmd >> 20) & 0x07f);
950 unsigned int verb = ((cmd >> 8) & 0x0fff);
952 /* CS8409 pins have no AC_PINSENSE_PRESENCE
953 * capabilities. We have to intercept 2 calls for pins 0x24 and 0x34
954 * and return correct pin sense values for read_pin_sense() call from
955 * hda_jack based on CS42L42 jack detect status.
958 case CS8409_CS42L42_HP_PIN_NID:
959 if (verb == AC_VERB_GET_PIN_SENSE) {
960 *res = (cs42l42->hp_jack_in) ? AC_PINSENSE_PRESENCE : 0;
964 case CS8409_CS42L42_AMIC_PIN_NID:
965 if (verb == AC_VERB_GET_PIN_SENSE) {
966 *res = (cs42l42->mic_jack_in) ? AC_PINSENSE_PRESENCE : 0;
974 return spec->exec_verb(dev, cmd, flags, res);
977 void cs8409_cs42l42_fixups(struct hda_codec *codec, const struct hda_fixup *fix, int action)
979 struct cs8409_spec *spec = codec->spec;
982 case HDA_FIXUP_ACT_PRE_PROBE:
983 snd_hda_add_verbs(codec, cs8409_cs42l42_init_verbs);
984 /* verb exec op override */
985 spec->exec_verb = codec->core.exec_verb;
986 codec->core.exec_verb = cs8409_cs42l42_exec_verb;
988 spec->scodecs[CS8409_CODEC0] = &cs8409_cs42l42_codec;
989 spec->num_scodecs = 1;
990 spec->scodecs[CS8409_CODEC0]->codec = codec;
991 codec->patch_ops = cs8409_cs42l42_patch_ops;
993 spec->gen.suppress_auto_mute = 1;
994 spec->gen.no_primary_hp = 1;
995 spec->gen.suppress_vmaster = 1;
997 /* GPIO 5 out, 3,4 in */
998 spec->gpio_dir = spec->scodecs[CS8409_CODEC0]->reset_gpio;
1000 spec->gpio_mask = 0x03f;
1002 /* Basic initial sequence for specific hw configuration */
1003 snd_hda_sequence_write(codec, cs8409_cs42l42_init_verbs);
1005 cs8409_fix_caps(codec, CS8409_CS42L42_HP_PIN_NID);
1006 cs8409_fix_caps(codec, CS8409_CS42L42_AMIC_PIN_NID);
1008 /* Set TIP_SENSE_EN for analog front-end of tip sense.
1009 * Additionally set HSBIAS_SENSE_EN and Full Scale volume for some variants.
1011 switch (codec->fixup_id) {
1013 spec->scodecs[CS8409_CODEC0]->hsbias_hiz = 0x00a0;
1014 spec->scodecs[CS8409_CODEC0]->full_scale_vol =
1015 CS42L42_FULL_SCALE_VOL_MINUS6DB;
1017 case CS8409_WARLOCK_MLK:
1018 case CS8409_WARLOCK_MLK_DUAL_MIC:
1019 spec->scodecs[CS8409_CODEC0]->hsbias_hiz = 0x0020;
1020 spec->scodecs[CS8409_CODEC0]->full_scale_vol = CS42L42_FULL_SCALE_VOL_0DB;
1023 spec->scodecs[CS8409_CODEC0]->hsbias_hiz = 0x0020;
1024 spec->scodecs[CS8409_CODEC0]->full_scale_vol =
1025 CS42L42_FULL_SCALE_VOL_MINUS6DB;
1030 case HDA_FIXUP_ACT_PROBE:
1031 /* Fix Sample Rate to 48kHz */
1032 spec->gen.stream_analog_playback = &cs42l42_48k_pcm_analog_playback;
1033 spec->gen.stream_analog_capture = &cs42l42_48k_pcm_analog_capture;
1035 spec->gen.pcm_playback_hook = cs42l42_playback_pcm_hook;
1036 spec->gen.pcm_capture_hook = cs42l42_capture_pcm_hook;
1037 /* Set initial DMIC volume to -26 dB */
1038 snd_hda_codec_amp_init_stereo(codec, CS8409_CS42L42_DMIC_ADC_PIN_NID,
1039 HDA_INPUT, 0, 0xff, 0x19);
1040 snd_hda_gen_add_kctl(&spec->gen, "Headphone Playback Volume",
1041 &cs42l42_dac_volume_mixer);
1042 snd_hda_gen_add_kctl(&spec->gen, "Mic Capture Volume",
1043 &cs42l42_adc_volume_mixer);
1044 /* Disable Unsolicited Response during boot */
1045 cs8409_enable_ur(codec, 0);
1046 snd_hda_codec_set_name(codec, "CS8409/CS42L42");
1048 case HDA_FIXUP_ACT_INIT:
1049 cs8409_cs42l42_hw_init(codec);
1050 spec->init_done = 1;
1051 if (spec->init_done && spec->build_ctrl_done
1052 && !spec->scodecs[CS8409_CODEC0]->hp_jack_in)
1053 cs42l42_run_jack_detect(spec->scodecs[CS8409_CODEC0]);
1055 case HDA_FIXUP_ACT_BUILD:
1056 spec->build_ctrl_done = 1;
1057 /* Run jack auto detect first time on boot
1058 * after controls have been added, to check if jack has
1059 * been already plugged in.
1060 * Run immediately after init.
1062 if (spec->init_done && spec->build_ctrl_done
1063 && !spec->scodecs[CS8409_CODEC0]->hp_jack_in)
1064 cs42l42_run_jack_detect(spec->scodecs[CS8409_CODEC0]);
1071 /******************************************************************************
1072 * Dolphin Specific Functions
1073 * CS8409/ 2 X CS42L42
1074 ******************************************************************************/
1077 * In the case of CS8409 we do not have unsolicited events when
1078 * hs mic and hp are connected. Companion codec CS42L42 will
1079 * generate interrupt via irq_mask to notify jack events. We have to overwrite
1080 * generic snd_hda_jack_unsol_event(), read CS42L42 jack detect status registers
1081 * and then notify status via generic snd_hda_jack_unsol_event() call.
1083 static void dolphin_jack_unsol_event(struct hda_codec *codec, unsigned int res)
1085 struct cs8409_spec *spec = codec->spec;
1086 struct sub_codec *cs42l42;
1087 struct hda_jack_tbl *jk;
1089 cs42l42 = spec->scodecs[CS8409_CODEC0];
1090 if (!cs42l42->suspended && (~res & cs42l42->irq_mask) &&
1091 cs42l42_jack_unsol_event(cs42l42)) {
1092 jk = snd_hda_jack_tbl_get_mst(codec, DOLPHIN_HP_PIN_NID, 0);
1094 snd_hda_jack_unsol_event(codec,
1095 (jk->tag << AC_UNSOL_RES_TAG_SHIFT) &
1098 jk = snd_hda_jack_tbl_get_mst(codec, DOLPHIN_AMIC_PIN_NID, 0);
1100 snd_hda_jack_unsol_event(codec,
1101 (jk->tag << AC_UNSOL_RES_TAG_SHIFT) &
1105 cs42l42 = spec->scodecs[CS8409_CODEC1];
1106 if (!cs42l42->suspended && (~res & cs42l42->irq_mask) &&
1107 cs42l42_jack_unsol_event(cs42l42)) {
1108 jk = snd_hda_jack_tbl_get_mst(codec, DOLPHIN_LO_PIN_NID, 0);
1110 snd_hda_jack_unsol_event(codec,
1111 (jk->tag << AC_UNSOL_RES_TAG_SHIFT) &
1116 /* Vendor specific HW configuration
1117 * PLL, ASP, I2C, SPI, GPIOs, DMIC etc...
1119 static void dolphin_hw_init(struct hda_codec *codec)
1121 const struct cs8409_cir_param *seq = dolphin_hw_cfg;
1122 struct cs8409_spec *spec = codec->spec;
1123 struct sub_codec *cs42l42;
1126 if (spec->gpio_mask) {
1127 snd_hda_codec_write(codec, CS8409_PIN_AFG, 0, AC_VERB_SET_GPIO_MASK,
1129 snd_hda_codec_write(codec, CS8409_PIN_AFG, 0, AC_VERB_SET_GPIO_DIRECTION,
1131 snd_hda_codec_write(codec, CS8409_PIN_AFG, 0, AC_VERB_SET_GPIO_DATA,
1135 for (; seq->nid; seq++)
1136 cs8409_vendor_coef_set(codec, seq->cir, seq->coeff);
1138 for (i = 0; i < spec->num_scodecs; i++) {
1139 cs42l42 = spec->scodecs[i];
1140 cs42l42_resume(cs42l42);
1143 /* Enable Unsolicited Response */
1144 cs8409_enable_ur(codec, 1);
1147 static const struct hda_codec_ops cs8409_dolphin_patch_ops = {
1148 .build_controls = cs8409_build_controls,
1149 .build_pcms = snd_hda_gen_build_pcms,
1150 .init = cs8409_init,
1151 .free = cs8409_free,
1152 .unsol_event = dolphin_jack_unsol_event,
1154 .suspend = cs8409_cs42l42_suspend,
1158 static int dolphin_exec_verb(struct hdac_device *dev, unsigned int cmd, unsigned int flags,
1161 struct hda_codec *codec = container_of(dev, struct hda_codec, core);
1162 struct cs8409_spec *spec = codec->spec;
1163 struct sub_codec *cs42l42 = spec->scodecs[CS8409_CODEC0];
1165 unsigned int nid = ((cmd >> 20) & 0x07f);
1166 unsigned int verb = ((cmd >> 8) & 0x0fff);
1168 /* CS8409 pins have no AC_PINSENSE_PRESENCE
1169 * capabilities. We have to intercept calls for CS42L42 pins
1170 * and return correct pin sense values for read_pin_sense() call from
1171 * hda_jack based on CS42L42 jack detect status.
1174 case DOLPHIN_HP_PIN_NID:
1175 case DOLPHIN_LO_PIN_NID:
1176 if (nid == DOLPHIN_LO_PIN_NID)
1177 cs42l42 = spec->scodecs[CS8409_CODEC1];
1178 if (verb == AC_VERB_GET_PIN_SENSE) {
1179 *res = (cs42l42->hp_jack_in) ? AC_PINSENSE_PRESENCE : 0;
1183 case DOLPHIN_AMIC_PIN_NID:
1184 if (verb == AC_VERB_GET_PIN_SENSE) {
1185 *res = (cs42l42->mic_jack_in) ? AC_PINSENSE_PRESENCE : 0;
1193 return spec->exec_verb(dev, cmd, flags, res);
1196 void dolphin_fixups(struct hda_codec *codec, const struct hda_fixup *fix, int action)
1198 struct cs8409_spec *spec = codec->spec;
1199 struct snd_kcontrol_new *kctrl;
1203 case HDA_FIXUP_ACT_PRE_PROBE:
1204 snd_hda_add_verbs(codec, dolphin_init_verbs);
1205 /* verb exec op override */
1206 spec->exec_verb = codec->core.exec_verb;
1207 codec->core.exec_verb = dolphin_exec_verb;
1209 spec->scodecs[CS8409_CODEC0] = &dolphin_cs42l42_0;
1210 spec->scodecs[CS8409_CODEC0]->codec = codec;
1211 spec->scodecs[CS8409_CODEC1] = &dolphin_cs42l42_1;
1212 spec->scodecs[CS8409_CODEC1]->codec = codec;
1213 spec->num_scodecs = 2;
1215 codec->patch_ops = cs8409_dolphin_patch_ops;
1217 /* GPIO 1,5 out, 0,4 in */
1218 spec->gpio_dir = spec->scodecs[CS8409_CODEC0]->reset_gpio |
1219 spec->scodecs[CS8409_CODEC1]->reset_gpio;
1220 spec->gpio_data = 0;
1221 spec->gpio_mask = 0x03f;
1223 /* Basic initial sequence for specific hw configuration */
1224 snd_hda_sequence_write(codec, dolphin_init_verbs);
1226 snd_hda_jack_add_kctl(codec, DOLPHIN_LO_PIN_NID, "Line Out", true,
1227 SND_JACK_HEADPHONE, NULL);
1229 snd_hda_jack_add_kctl(codec, DOLPHIN_AMIC_PIN_NID, "Microphone", true,
1230 SND_JACK_MICROPHONE, NULL);
1232 cs8409_fix_caps(codec, DOLPHIN_HP_PIN_NID);
1233 cs8409_fix_caps(codec, DOLPHIN_LO_PIN_NID);
1234 cs8409_fix_caps(codec, DOLPHIN_AMIC_PIN_NID);
1236 spec->scodecs[CS8409_CODEC0]->full_scale_vol = CS42L42_FULL_SCALE_VOL_MINUS6DB;
1237 spec->scodecs[CS8409_CODEC1]->full_scale_vol = CS42L42_FULL_SCALE_VOL_MINUS6DB;
1240 case HDA_FIXUP_ACT_PROBE:
1241 /* Fix Sample Rate to 48kHz */
1242 spec->gen.stream_analog_playback = &cs42l42_48k_pcm_analog_playback;
1243 spec->gen.stream_analog_capture = &cs42l42_48k_pcm_analog_capture;
1245 spec->gen.pcm_playback_hook = cs42l42_playback_pcm_hook;
1246 spec->gen.pcm_capture_hook = cs42l42_capture_pcm_hook;
1247 snd_hda_gen_add_kctl(&spec->gen, "Headphone Playback Volume",
1248 &cs42l42_dac_volume_mixer);
1249 snd_hda_gen_add_kctl(&spec->gen, "Mic Capture Volume", &cs42l42_adc_volume_mixer);
1250 kctrl = snd_hda_gen_add_kctl(&spec->gen, "Line Out Playback Volume",
1251 &cs42l42_dac_volume_mixer);
1252 /* Update Line Out kcontrol template */
1253 kctrl->private_value = HDA_COMPOSE_AMP_VAL_OFS(DOLPHIN_HP_PIN_NID, 3, CS8409_CODEC1,
1254 HDA_OUTPUT, CS42L42_VOL_DAC) | HDA_AMP_VAL_MIN_MUTE;
1255 cs8409_enable_ur(codec, 0);
1256 snd_hda_codec_set_name(codec, "CS8409/CS42L42");
1258 case HDA_FIXUP_ACT_INIT:
1259 dolphin_hw_init(codec);
1260 spec->init_done = 1;
1261 if (spec->init_done && spec->build_ctrl_done) {
1262 for (i = 0; i < spec->num_scodecs; i++) {
1263 if (!spec->scodecs[i]->hp_jack_in)
1264 cs42l42_run_jack_detect(spec->scodecs[i]);
1268 case HDA_FIXUP_ACT_BUILD:
1269 spec->build_ctrl_done = 1;
1270 /* Run jack auto detect first time on boot
1271 * after controls have been added, to check if jack has
1272 * been already plugged in.
1273 * Run immediately after init.
1275 if (spec->init_done && spec->build_ctrl_done) {
1276 for (i = 0; i < spec->num_scodecs; i++) {
1277 if (!spec->scodecs[i]->hp_jack_in)
1278 cs42l42_run_jack_detect(spec->scodecs[i]);
1287 static int patch_cs8409(struct hda_codec *codec)
1291 if (!cs8409_alloc_spec(codec))
1294 snd_hda_pick_fixup(codec, cs8409_models, cs8409_fixup_tbl, cs8409_fixups);
1296 codec_dbg(codec, "Picked ID=%d, VID=%08x, DEV=%08x\n", codec->fixup_id,
1297 codec->bus->pci->subsystem_vendor,
1298 codec->bus->pci->subsystem_device);
1300 snd_hda_apply_fixup(codec, HDA_FIXUP_ACT_PRE_PROBE);
1302 err = cs8409_parse_auto_config(codec);
1308 snd_hda_apply_fixup(codec, HDA_FIXUP_ACT_PROBE);
1312 static const struct hda_device_id snd_hda_id_cs8409[] = {
1313 HDA_CODEC_ENTRY(0x10138409, "CS8409", patch_cs8409),
1316 MODULE_DEVICE_TABLE(hdaudio, snd_hda_id_cs8409);
1318 static struct hda_codec_driver cs8409_driver = {
1319 .id = snd_hda_id_cs8409,
1321 module_hda_codec_driver(cs8409_driver);
1323 MODULE_LICENSE("GPL");
1324 MODULE_DESCRIPTION("Cirrus Logic HDA bridge");