ALSA: usb-audio: Avoid access before bLength check in build_audio_procunit()
[linux/fpc-iii.git] / sound / soc / codecs / sgtl5000.c
blob3dba5550a6659152df5c8feec4e00daa2bbd33e7
1 /*
2 * sgtl5000.c -- SGTL5000 ALSA SoC Audio driver
4 * Copyright 2010-2011 Freescale Semiconductor, Inc. All Rights Reserved.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 */
11 #include <linux/module.h>
12 #include <linux/moduleparam.h>
13 #include <linux/init.h>
14 #include <linux/delay.h>
15 #include <linux/slab.h>
16 #include <linux/pm.h>
17 #include <linux/i2c.h>
18 #include <linux/clk.h>
19 #include <linux/log2.h>
20 #include <linux/regmap.h>
21 #include <linux/regulator/driver.h>
22 #include <linux/regulator/machine.h>
23 #include <linux/regulator/consumer.h>
24 #include <linux/of_device.h>
25 #include <sound/core.h>
26 #include <sound/tlv.h>
27 #include <sound/pcm.h>
28 #include <sound/pcm_params.h>
29 #include <sound/soc.h>
30 #include <sound/soc-dapm.h>
31 #include <sound/initval.h>
33 #include "sgtl5000.h"
35 #define SGTL5000_DAP_REG_OFFSET 0x0100
36 #define SGTL5000_MAX_REG_OFFSET 0x013A
38 /* default value of sgtl5000 registers */
39 static const struct reg_default sgtl5000_reg_defaults[] = {
40 { SGTL5000_CHIP_DIG_POWER, 0x0000 },
41 { SGTL5000_CHIP_I2S_CTRL, 0x0010 },
42 { SGTL5000_CHIP_SSS_CTRL, 0x0010 },
43 { SGTL5000_CHIP_ADCDAC_CTRL, 0x020c },
44 { SGTL5000_CHIP_DAC_VOL, 0x3c3c },
45 { SGTL5000_CHIP_PAD_STRENGTH, 0x015f },
46 { SGTL5000_CHIP_ANA_ADC_CTRL, 0x0000 },
47 { SGTL5000_CHIP_ANA_HP_CTRL, 0x1818 },
48 { SGTL5000_CHIP_ANA_CTRL, 0x0111 },
49 { SGTL5000_CHIP_REF_CTRL, 0x0000 },
50 { SGTL5000_CHIP_MIC_CTRL, 0x0000 },
51 { SGTL5000_CHIP_LINE_OUT_CTRL, 0x0000 },
52 { SGTL5000_CHIP_LINE_OUT_VOL, 0x0404 },
53 { SGTL5000_CHIP_PLL_CTRL, 0x5000 },
54 { SGTL5000_CHIP_CLK_TOP_CTRL, 0x0000 },
55 { SGTL5000_CHIP_ANA_STATUS, 0x0000 },
56 { SGTL5000_CHIP_SHORT_CTRL, 0x0000 },
57 { SGTL5000_CHIP_ANA_TEST2, 0x0000 },
58 { SGTL5000_DAP_CTRL, 0x0000 },
59 { SGTL5000_DAP_PEQ, 0x0000 },
60 { SGTL5000_DAP_BASS_ENHANCE, 0x0040 },
61 { SGTL5000_DAP_BASS_ENHANCE_CTRL, 0x051f },
62 { SGTL5000_DAP_AUDIO_EQ, 0x0000 },
63 { SGTL5000_DAP_SURROUND, 0x0040 },
64 { SGTL5000_DAP_EQ_BASS_BAND0, 0x002f },
65 { SGTL5000_DAP_EQ_BASS_BAND1, 0x002f },
66 { SGTL5000_DAP_EQ_BASS_BAND2, 0x002f },
67 { SGTL5000_DAP_EQ_BASS_BAND3, 0x002f },
68 { SGTL5000_DAP_EQ_BASS_BAND4, 0x002f },
69 { SGTL5000_DAP_MAIN_CHAN, 0x8000 },
70 { SGTL5000_DAP_MIX_CHAN, 0x0000 },
71 { SGTL5000_DAP_AVC_CTRL, 0x0510 },
72 { SGTL5000_DAP_AVC_THRESHOLD, 0x1473 },
73 { SGTL5000_DAP_AVC_ATTACK, 0x0028 },
74 { SGTL5000_DAP_AVC_DECAY, 0x0050 },
77 /* regulator supplies for sgtl5000, VDDD is an optional external supply */
78 enum sgtl5000_regulator_supplies {
79 VDDA,
80 VDDIO,
81 VDDD,
82 SGTL5000_SUPPLY_NUM
85 /* vddd is optional supply */
86 static const char *supply_names[SGTL5000_SUPPLY_NUM] = {
87 "VDDA",
88 "VDDIO",
89 "VDDD"
92 #define LDO_VOLTAGE 1200000
93 #define LINREG_VDDD ((1600 - LDO_VOLTAGE / 1000) / 50)
95 enum sgtl5000_micbias_resistor {
96 SGTL5000_MICBIAS_OFF = 0,
97 SGTL5000_MICBIAS_2K = 2,
98 SGTL5000_MICBIAS_4K = 4,
99 SGTL5000_MICBIAS_8K = 8,
102 /* sgtl5000 private structure in codec */
103 struct sgtl5000_priv {
104 int sysclk; /* sysclk rate */
105 int master; /* i2s master or not */
106 int fmt; /* i2s data format */
107 struct regulator_bulk_data supplies[SGTL5000_SUPPLY_NUM];
108 int num_supplies;
109 struct regmap *regmap;
110 struct clk *mclk;
111 int revision;
112 u8 micbias_resistor;
113 u8 micbias_voltage;
117 * mic_bias power on/off share the same register bits with
118 * output impedance of mic bias, when power on mic bias, we
119 * need reclaim it to impedance value.
120 * 0x0 = Powered off
121 * 0x1 = 2Kohm
122 * 0x2 = 4Kohm
123 * 0x3 = 8Kohm
125 static int mic_bias_event(struct snd_soc_dapm_widget *w,
126 struct snd_kcontrol *kcontrol, int event)
128 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
129 struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
131 switch (event) {
132 case SND_SOC_DAPM_POST_PMU:
133 /* change mic bias resistor */
134 snd_soc_update_bits(codec, SGTL5000_CHIP_MIC_CTRL,
135 SGTL5000_BIAS_R_MASK,
136 sgtl5000->micbias_resistor << SGTL5000_BIAS_R_SHIFT);
137 break;
139 case SND_SOC_DAPM_PRE_PMD:
140 snd_soc_update_bits(codec, SGTL5000_CHIP_MIC_CTRL,
141 SGTL5000_BIAS_R_MASK, 0);
142 break;
144 return 0;
148 * As manual described, ADC/DAC only works when VAG powerup,
149 * So enabled VAG before ADC/DAC up.
150 * In power down case, we need wait 400ms when vag fully ramped down.
152 static int power_vag_event(struct snd_soc_dapm_widget *w,
153 struct snd_kcontrol *kcontrol, int event)
155 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
156 const u32 mask = SGTL5000_DAC_POWERUP | SGTL5000_ADC_POWERUP;
158 switch (event) {
159 case SND_SOC_DAPM_POST_PMU:
160 snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
161 SGTL5000_VAG_POWERUP, SGTL5000_VAG_POWERUP);
162 msleep(400);
163 break;
165 case SND_SOC_DAPM_PRE_PMD:
167 * Don't clear VAG_POWERUP, when both DAC and ADC are
168 * operational to prevent inadvertently starving the
169 * other one of them.
171 if ((snd_soc_read(codec, SGTL5000_CHIP_ANA_POWER) &
172 mask) != mask) {
173 snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
174 SGTL5000_VAG_POWERUP, 0);
175 msleep(400);
177 break;
178 default:
179 break;
182 return 0;
185 /* input sources for ADC */
186 static const char *adc_mux_text[] = {
187 "MIC_IN", "LINE_IN"
190 static SOC_ENUM_SINGLE_DECL(adc_enum,
191 SGTL5000_CHIP_ANA_CTRL, 2,
192 adc_mux_text);
194 static const struct snd_kcontrol_new adc_mux =
195 SOC_DAPM_ENUM("Capture Mux", adc_enum);
197 /* input sources for DAC */
198 static const char *dac_mux_text[] = {
199 "DAC", "LINE_IN"
202 static SOC_ENUM_SINGLE_DECL(dac_enum,
203 SGTL5000_CHIP_ANA_CTRL, 6,
204 dac_mux_text);
206 static const struct snd_kcontrol_new dac_mux =
207 SOC_DAPM_ENUM("Headphone Mux", dac_enum);
209 static const struct snd_soc_dapm_widget sgtl5000_dapm_widgets[] = {
210 SND_SOC_DAPM_INPUT("LINE_IN"),
211 SND_SOC_DAPM_INPUT("MIC_IN"),
213 SND_SOC_DAPM_OUTPUT("HP_OUT"),
214 SND_SOC_DAPM_OUTPUT("LINE_OUT"),
216 SND_SOC_DAPM_SUPPLY("Mic Bias", SGTL5000_CHIP_MIC_CTRL, 8, 0,
217 mic_bias_event,
218 SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD),
220 SND_SOC_DAPM_PGA("HP", SGTL5000_CHIP_ANA_POWER, 4, 0, NULL, 0),
221 SND_SOC_DAPM_PGA("LO", SGTL5000_CHIP_ANA_POWER, 0, 0, NULL, 0),
223 SND_SOC_DAPM_MUX("Capture Mux", SND_SOC_NOPM, 0, 0, &adc_mux),
224 SND_SOC_DAPM_MUX("Headphone Mux", SND_SOC_NOPM, 0, 0, &dac_mux),
226 /* aif for i2s input */
227 SND_SOC_DAPM_AIF_IN("AIFIN", "Playback",
228 0, SGTL5000_CHIP_DIG_POWER,
229 0, 0),
231 /* aif for i2s output */
232 SND_SOC_DAPM_AIF_OUT("AIFOUT", "Capture",
233 0, SGTL5000_CHIP_DIG_POWER,
234 1, 0),
236 SND_SOC_DAPM_ADC("ADC", "Capture", SGTL5000_CHIP_ANA_POWER, 1, 0),
237 SND_SOC_DAPM_DAC("DAC", "Playback", SGTL5000_CHIP_ANA_POWER, 3, 0),
239 SND_SOC_DAPM_PRE("VAG_POWER_PRE", power_vag_event),
240 SND_SOC_DAPM_POST("VAG_POWER_POST", power_vag_event),
243 /* routes for sgtl5000 */
244 static const struct snd_soc_dapm_route sgtl5000_dapm_routes[] = {
245 {"Capture Mux", "LINE_IN", "LINE_IN"}, /* line_in --> adc_mux */
246 {"Capture Mux", "MIC_IN", "MIC_IN"}, /* mic_in --> adc_mux */
248 {"ADC", NULL, "Capture Mux"}, /* adc_mux --> adc */
249 {"AIFOUT", NULL, "ADC"}, /* adc --> i2s_out */
251 {"DAC", NULL, "AIFIN"}, /* i2s-->dac,skip audio mux */
252 {"Headphone Mux", "DAC", "DAC"}, /* dac --> hp_mux */
253 {"LO", NULL, "DAC"}, /* dac --> line_out */
255 {"Headphone Mux", "LINE_IN", "LINE_IN"},/* line_in --> hp_mux */
256 {"HP", NULL, "Headphone Mux"}, /* hp_mux --> hp */
258 {"LINE_OUT", NULL, "LO"},
259 {"HP_OUT", NULL, "HP"},
262 /* custom function to fetch info of PCM playback volume */
263 static int dac_info_volsw(struct snd_kcontrol *kcontrol,
264 struct snd_ctl_elem_info *uinfo)
266 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
267 uinfo->count = 2;
268 uinfo->value.integer.min = 0;
269 uinfo->value.integer.max = 0xfc - 0x3c;
270 return 0;
274 * custom function to get of PCM playback volume
276 * dac volume register
277 * 15-------------8-7--------------0
278 * | R channel vol | L channel vol |
279 * -------------------------------
281 * PCM volume with 0.5017 dB steps from 0 to -90 dB
283 * register values map to dB
284 * 0x3B and less = Reserved
285 * 0x3C = 0 dB
286 * 0x3D = -0.5 dB
287 * 0xF0 = -90 dB
288 * 0xFC and greater = Muted
290 * register value map to userspace value
292 * register value 0x3c(0dB) 0xf0(-90dB)0xfc
293 * ------------------------------
294 * userspace value 0xc0 0
296 static int dac_get_volsw(struct snd_kcontrol *kcontrol,
297 struct snd_ctl_elem_value *ucontrol)
299 struct snd_soc_codec *codec = snd_soc_kcontrol_codec(kcontrol);
300 int reg;
301 int l;
302 int r;
304 reg = snd_soc_read(codec, SGTL5000_CHIP_DAC_VOL);
306 /* get left channel volume */
307 l = (reg & SGTL5000_DAC_VOL_LEFT_MASK) >> SGTL5000_DAC_VOL_LEFT_SHIFT;
309 /* get right channel volume */
310 r = (reg & SGTL5000_DAC_VOL_RIGHT_MASK) >> SGTL5000_DAC_VOL_RIGHT_SHIFT;
312 /* make sure value fall in (0x3c,0xfc) */
313 l = clamp(l, 0x3c, 0xfc);
314 r = clamp(r, 0x3c, 0xfc);
316 /* invert it and map to userspace value */
317 l = 0xfc - l;
318 r = 0xfc - r;
320 ucontrol->value.integer.value[0] = l;
321 ucontrol->value.integer.value[1] = r;
323 return 0;
327 * custom function to put of PCM playback volume
329 * dac volume register
330 * 15-------------8-7--------------0
331 * | R channel vol | L channel vol |
332 * -------------------------------
334 * PCM volume with 0.5017 dB steps from 0 to -90 dB
336 * register values map to dB
337 * 0x3B and less = Reserved
338 * 0x3C = 0 dB
339 * 0x3D = -0.5 dB
340 * 0xF0 = -90 dB
341 * 0xFC and greater = Muted
343 * userspace value map to register value
345 * userspace value 0xc0 0
346 * ------------------------------
347 * register value 0x3c(0dB) 0xf0(-90dB)0xfc
349 static int dac_put_volsw(struct snd_kcontrol *kcontrol,
350 struct snd_ctl_elem_value *ucontrol)
352 struct snd_soc_codec *codec = snd_soc_kcontrol_codec(kcontrol);
353 int reg;
354 int l;
355 int r;
357 l = ucontrol->value.integer.value[0];
358 r = ucontrol->value.integer.value[1];
360 /* make sure userspace volume fall in (0, 0xfc-0x3c) */
361 l = clamp(l, 0, 0xfc - 0x3c);
362 r = clamp(r, 0, 0xfc - 0x3c);
364 /* invert it, get the value can be set to register */
365 l = 0xfc - l;
366 r = 0xfc - r;
368 /* shift to get the register value */
369 reg = l << SGTL5000_DAC_VOL_LEFT_SHIFT |
370 r << SGTL5000_DAC_VOL_RIGHT_SHIFT;
372 snd_soc_write(codec, SGTL5000_CHIP_DAC_VOL, reg);
374 return 0;
377 static const DECLARE_TLV_DB_SCALE(capture_6db_attenuate, -600, 600, 0);
379 /* tlv for mic gain, 0db 20db 30db 40db */
380 static const DECLARE_TLV_DB_RANGE(mic_gain_tlv,
381 0, 0, TLV_DB_SCALE_ITEM(0, 0, 0),
382 1, 3, TLV_DB_SCALE_ITEM(2000, 1000, 0)
385 /* tlv for hp volume, -51.5db to 12.0db, step .5db */
386 static const DECLARE_TLV_DB_SCALE(headphone_volume, -5150, 50, 0);
388 /* tlv for lineout volume, 31 steps of .5db each */
389 static const DECLARE_TLV_DB_SCALE(lineout_volume, -1550, 50, 0);
391 static const struct snd_kcontrol_new sgtl5000_snd_controls[] = {
392 /* SOC_DOUBLE_S8_TLV with invert */
394 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
395 .name = "PCM Playback Volume",
396 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |
397 SNDRV_CTL_ELEM_ACCESS_READWRITE,
398 .info = dac_info_volsw,
399 .get = dac_get_volsw,
400 .put = dac_put_volsw,
403 SOC_DOUBLE("Capture Volume", SGTL5000_CHIP_ANA_ADC_CTRL, 0, 4, 0xf, 0),
404 SOC_SINGLE_TLV("Capture Attenuate Switch (-6dB)",
405 SGTL5000_CHIP_ANA_ADC_CTRL,
406 8, 1, 0, capture_6db_attenuate),
407 SOC_SINGLE("Capture ZC Switch", SGTL5000_CHIP_ANA_CTRL, 1, 1, 0),
409 SOC_DOUBLE_TLV("Headphone Playback Volume",
410 SGTL5000_CHIP_ANA_HP_CTRL,
411 0, 8,
412 0x7f, 1,
413 headphone_volume),
414 SOC_SINGLE("Headphone Playback Switch", SGTL5000_CHIP_ANA_CTRL,
415 4, 1, 1),
416 SOC_SINGLE("Headphone Playback ZC Switch", SGTL5000_CHIP_ANA_CTRL,
417 5, 1, 0),
419 SOC_SINGLE_TLV("Mic Volume", SGTL5000_CHIP_MIC_CTRL,
420 0, 3, 0, mic_gain_tlv),
422 SOC_DOUBLE_TLV("Lineout Playback Volume",
423 SGTL5000_CHIP_LINE_OUT_VOL,
424 SGTL5000_LINE_OUT_VOL_LEFT_SHIFT,
425 SGTL5000_LINE_OUT_VOL_RIGHT_SHIFT,
426 0x1f, 1,
427 lineout_volume),
428 SOC_SINGLE("Lineout Playback Switch", SGTL5000_CHIP_ANA_CTRL, 8, 1, 1),
431 /* mute the codec used by alsa core */
432 static int sgtl5000_digital_mute(struct snd_soc_dai *codec_dai, int mute)
434 struct snd_soc_codec *codec = codec_dai->codec;
435 u16 adcdac_ctrl = SGTL5000_DAC_MUTE_LEFT | SGTL5000_DAC_MUTE_RIGHT;
437 snd_soc_update_bits(codec, SGTL5000_CHIP_ADCDAC_CTRL,
438 adcdac_ctrl, mute ? adcdac_ctrl : 0);
440 return 0;
443 /* set codec format */
444 static int sgtl5000_set_dai_fmt(struct snd_soc_dai *codec_dai, unsigned int fmt)
446 struct snd_soc_codec *codec = codec_dai->codec;
447 struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
448 u16 i2sctl = 0;
450 sgtl5000->master = 0;
452 * i2s clock and frame master setting.
453 * ONLY support:
454 * - clock and frame slave,
455 * - clock and frame master
457 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
458 case SND_SOC_DAIFMT_CBS_CFS:
459 break;
460 case SND_SOC_DAIFMT_CBM_CFM:
461 i2sctl |= SGTL5000_I2S_MASTER;
462 sgtl5000->master = 1;
463 break;
464 default:
465 return -EINVAL;
468 /* setting i2s data format */
469 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
470 case SND_SOC_DAIFMT_DSP_A:
471 i2sctl |= SGTL5000_I2S_MODE_PCM << SGTL5000_I2S_MODE_SHIFT;
472 break;
473 case SND_SOC_DAIFMT_DSP_B:
474 i2sctl |= SGTL5000_I2S_MODE_PCM << SGTL5000_I2S_MODE_SHIFT;
475 i2sctl |= SGTL5000_I2S_LRALIGN;
476 break;
477 case SND_SOC_DAIFMT_I2S:
478 i2sctl |= SGTL5000_I2S_MODE_I2S_LJ << SGTL5000_I2S_MODE_SHIFT;
479 break;
480 case SND_SOC_DAIFMT_RIGHT_J:
481 i2sctl |= SGTL5000_I2S_MODE_RJ << SGTL5000_I2S_MODE_SHIFT;
482 i2sctl |= SGTL5000_I2S_LRPOL;
483 break;
484 case SND_SOC_DAIFMT_LEFT_J:
485 i2sctl |= SGTL5000_I2S_MODE_I2S_LJ << SGTL5000_I2S_MODE_SHIFT;
486 i2sctl |= SGTL5000_I2S_LRALIGN;
487 break;
488 default:
489 return -EINVAL;
492 sgtl5000->fmt = fmt & SND_SOC_DAIFMT_FORMAT_MASK;
494 /* Clock inversion */
495 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
496 case SND_SOC_DAIFMT_NB_NF:
497 break;
498 case SND_SOC_DAIFMT_IB_NF:
499 i2sctl |= SGTL5000_I2S_SCLK_INV;
500 break;
501 default:
502 return -EINVAL;
505 snd_soc_write(codec, SGTL5000_CHIP_I2S_CTRL, i2sctl);
507 return 0;
510 /* set codec sysclk */
511 static int sgtl5000_set_dai_sysclk(struct snd_soc_dai *codec_dai,
512 int clk_id, unsigned int freq, int dir)
514 struct snd_soc_codec *codec = codec_dai->codec;
515 struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
517 switch (clk_id) {
518 case SGTL5000_SYSCLK:
519 sgtl5000->sysclk = freq;
520 break;
521 default:
522 return -EINVAL;
525 return 0;
529 * set clock according to i2s frame clock,
530 * sgtl5000 provides 2 clock sources:
531 * 1. sys_mclk: sample freq can only be configured to
532 * 1/256, 1/384, 1/512 of sys_mclk.
533 * 2. pll: can derive any audio clocks.
535 * clock setting rules:
536 * 1. in slave mode, only sys_mclk can be used
537 * 2. as constraint by sys_mclk, sample freq should be set to 32 kHz, 44.1 kHz
538 * and above.
539 * 3. usage of sys_mclk is preferred over pll to save power.
541 static int sgtl5000_set_clock(struct snd_soc_codec *codec, int frame_rate)
543 struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
544 int clk_ctl = 0;
545 int sys_fs; /* sample freq */
548 * sample freq should be divided by frame clock,
549 * if frame clock is lower than 44.1 kHz, sample freq should be set to
550 * 32 kHz or 44.1 kHz.
552 switch (frame_rate) {
553 case 8000:
554 case 16000:
555 sys_fs = 32000;
556 break;
557 case 11025:
558 case 22050:
559 sys_fs = 44100;
560 break;
561 default:
562 sys_fs = frame_rate;
563 break;
566 /* set divided factor of frame clock */
567 switch (sys_fs / frame_rate) {
568 case 4:
569 clk_ctl |= SGTL5000_RATE_MODE_DIV_4 << SGTL5000_RATE_MODE_SHIFT;
570 break;
571 case 2:
572 clk_ctl |= SGTL5000_RATE_MODE_DIV_2 << SGTL5000_RATE_MODE_SHIFT;
573 break;
574 case 1:
575 clk_ctl |= SGTL5000_RATE_MODE_DIV_1 << SGTL5000_RATE_MODE_SHIFT;
576 break;
577 default:
578 return -EINVAL;
581 /* set the sys_fs according to frame rate */
582 switch (sys_fs) {
583 case 32000:
584 clk_ctl |= SGTL5000_SYS_FS_32k << SGTL5000_SYS_FS_SHIFT;
585 break;
586 case 44100:
587 clk_ctl |= SGTL5000_SYS_FS_44_1k << SGTL5000_SYS_FS_SHIFT;
588 break;
589 case 48000:
590 clk_ctl |= SGTL5000_SYS_FS_48k << SGTL5000_SYS_FS_SHIFT;
591 break;
592 case 96000:
593 clk_ctl |= SGTL5000_SYS_FS_96k << SGTL5000_SYS_FS_SHIFT;
594 break;
595 default:
596 dev_err(codec->dev, "frame rate %d not supported\n",
597 frame_rate);
598 return -EINVAL;
602 * calculate the divider of mclk/sample_freq,
603 * factor of freq = 96 kHz can only be 256, since mclk is in the range
604 * of 8 MHz - 27 MHz
606 switch (sgtl5000->sysclk / frame_rate) {
607 case 256:
608 clk_ctl |= SGTL5000_MCLK_FREQ_256FS <<
609 SGTL5000_MCLK_FREQ_SHIFT;
610 break;
611 case 384:
612 clk_ctl |= SGTL5000_MCLK_FREQ_384FS <<
613 SGTL5000_MCLK_FREQ_SHIFT;
614 break;
615 case 512:
616 clk_ctl |= SGTL5000_MCLK_FREQ_512FS <<
617 SGTL5000_MCLK_FREQ_SHIFT;
618 break;
619 default:
620 /* if mclk does not satisfy the divider, use pll */
621 if (sgtl5000->master) {
622 clk_ctl |= SGTL5000_MCLK_FREQ_PLL <<
623 SGTL5000_MCLK_FREQ_SHIFT;
624 } else {
625 dev_err(codec->dev,
626 "PLL not supported in slave mode\n");
627 dev_err(codec->dev, "%d ratio is not supported. "
628 "SYS_MCLK needs to be 256, 384 or 512 * fs\n",
629 sgtl5000->sysclk / frame_rate);
630 return -EINVAL;
634 /* if using pll, please check manual 6.4.2 for detail */
635 if ((clk_ctl & SGTL5000_MCLK_FREQ_MASK) == SGTL5000_MCLK_FREQ_PLL) {
636 u64 out, t;
637 int div2;
638 int pll_ctl;
639 unsigned int in, int_div, frac_div;
641 if (sgtl5000->sysclk > 17000000) {
642 div2 = 1;
643 in = sgtl5000->sysclk / 2;
644 } else {
645 div2 = 0;
646 in = sgtl5000->sysclk;
648 if (sys_fs == 44100)
649 out = 180633600;
650 else
651 out = 196608000;
652 t = do_div(out, in);
653 int_div = out;
654 t *= 2048;
655 do_div(t, in);
656 frac_div = t;
657 pll_ctl = int_div << SGTL5000_PLL_INT_DIV_SHIFT |
658 frac_div << SGTL5000_PLL_FRAC_DIV_SHIFT;
660 snd_soc_write(codec, SGTL5000_CHIP_PLL_CTRL, pll_ctl);
661 if (div2)
662 snd_soc_update_bits(codec,
663 SGTL5000_CHIP_CLK_TOP_CTRL,
664 SGTL5000_INPUT_FREQ_DIV2,
665 SGTL5000_INPUT_FREQ_DIV2);
666 else
667 snd_soc_update_bits(codec,
668 SGTL5000_CHIP_CLK_TOP_CTRL,
669 SGTL5000_INPUT_FREQ_DIV2,
672 /* power up pll */
673 snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
674 SGTL5000_PLL_POWERUP | SGTL5000_VCOAMP_POWERUP,
675 SGTL5000_PLL_POWERUP | SGTL5000_VCOAMP_POWERUP);
677 /* if using pll, clk_ctrl must be set after pll power up */
678 snd_soc_write(codec, SGTL5000_CHIP_CLK_CTRL, clk_ctl);
679 } else {
680 /* otherwise, clk_ctrl must be set before pll power down */
681 snd_soc_write(codec, SGTL5000_CHIP_CLK_CTRL, clk_ctl);
683 /* power down pll */
684 snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
685 SGTL5000_PLL_POWERUP | SGTL5000_VCOAMP_POWERUP,
689 return 0;
693 * Set PCM DAI bit size and sample rate.
694 * input: params_rate, params_fmt
696 static int sgtl5000_pcm_hw_params(struct snd_pcm_substream *substream,
697 struct snd_pcm_hw_params *params,
698 struct snd_soc_dai *dai)
700 struct snd_soc_codec *codec = dai->codec;
701 struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
702 int channels = params_channels(params);
703 int i2s_ctl = 0;
704 int stereo;
705 int ret;
707 /* sysclk should already set */
708 if (!sgtl5000->sysclk) {
709 dev_err(codec->dev, "%s: set sysclk first!\n", __func__);
710 return -EFAULT;
713 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
714 stereo = SGTL5000_DAC_STEREO;
715 else
716 stereo = SGTL5000_ADC_STEREO;
718 /* set mono to save power */
719 snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER, stereo,
720 channels == 1 ? 0 : stereo);
722 /* set codec clock base on lrclk */
723 ret = sgtl5000_set_clock(codec, params_rate(params));
724 if (ret)
725 return ret;
727 /* set i2s data format */
728 switch (params_width(params)) {
729 case 16:
730 if (sgtl5000->fmt == SND_SOC_DAIFMT_RIGHT_J)
731 return -EINVAL;
732 i2s_ctl |= SGTL5000_I2S_DLEN_16 << SGTL5000_I2S_DLEN_SHIFT;
733 i2s_ctl |= SGTL5000_I2S_SCLKFREQ_32FS <<
734 SGTL5000_I2S_SCLKFREQ_SHIFT;
735 break;
736 case 20:
737 i2s_ctl |= SGTL5000_I2S_DLEN_20 << SGTL5000_I2S_DLEN_SHIFT;
738 i2s_ctl |= SGTL5000_I2S_SCLKFREQ_64FS <<
739 SGTL5000_I2S_SCLKFREQ_SHIFT;
740 break;
741 case 24:
742 i2s_ctl |= SGTL5000_I2S_DLEN_24 << SGTL5000_I2S_DLEN_SHIFT;
743 i2s_ctl |= SGTL5000_I2S_SCLKFREQ_64FS <<
744 SGTL5000_I2S_SCLKFREQ_SHIFT;
745 break;
746 case 32:
747 if (sgtl5000->fmt == SND_SOC_DAIFMT_RIGHT_J)
748 return -EINVAL;
749 i2s_ctl |= SGTL5000_I2S_DLEN_32 << SGTL5000_I2S_DLEN_SHIFT;
750 i2s_ctl |= SGTL5000_I2S_SCLKFREQ_64FS <<
751 SGTL5000_I2S_SCLKFREQ_SHIFT;
752 break;
753 default:
754 return -EINVAL;
757 snd_soc_update_bits(codec, SGTL5000_CHIP_I2S_CTRL,
758 SGTL5000_I2S_DLEN_MASK | SGTL5000_I2S_SCLKFREQ_MASK,
759 i2s_ctl);
761 return 0;
765 * set dac bias
766 * common state changes:
767 * startup:
768 * off --> standby --> prepare --> on
769 * standby --> prepare --> on
771 * stop:
772 * on --> prepare --> standby
774 static int sgtl5000_set_bias_level(struct snd_soc_codec *codec,
775 enum snd_soc_bias_level level)
777 struct sgtl5000_priv *sgtl = snd_soc_codec_get_drvdata(codec);
778 int ret;
780 switch (level) {
781 case SND_SOC_BIAS_ON:
782 case SND_SOC_BIAS_PREPARE:
783 case SND_SOC_BIAS_STANDBY:
784 regcache_cache_only(sgtl->regmap, false);
785 ret = regcache_sync(sgtl->regmap);
786 if (ret) {
787 regcache_cache_only(sgtl->regmap, true);
788 return ret;
791 snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
792 SGTL5000_REFTOP_POWERUP,
793 SGTL5000_REFTOP_POWERUP);
794 break;
795 case SND_SOC_BIAS_OFF:
796 regcache_cache_only(sgtl->regmap, true);
797 snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
798 SGTL5000_REFTOP_POWERUP, 0);
799 break;
802 return 0;
805 #define SGTL5000_FORMATS (SNDRV_PCM_FMTBIT_S16_LE |\
806 SNDRV_PCM_FMTBIT_S20_3LE |\
807 SNDRV_PCM_FMTBIT_S24_LE |\
808 SNDRV_PCM_FMTBIT_S32_LE)
810 static const struct snd_soc_dai_ops sgtl5000_ops = {
811 .hw_params = sgtl5000_pcm_hw_params,
812 .digital_mute = sgtl5000_digital_mute,
813 .set_fmt = sgtl5000_set_dai_fmt,
814 .set_sysclk = sgtl5000_set_dai_sysclk,
817 static struct snd_soc_dai_driver sgtl5000_dai = {
818 .name = "sgtl5000",
819 .playback = {
820 .stream_name = "Playback",
821 .channels_min = 1,
822 .channels_max = 2,
824 * only support 8~48K + 96K,
825 * TODO modify hw_param to support more
827 .rates = SNDRV_PCM_RATE_8000_48000 | SNDRV_PCM_RATE_96000,
828 .formats = SGTL5000_FORMATS,
830 .capture = {
831 .stream_name = "Capture",
832 .channels_min = 1,
833 .channels_max = 2,
834 .rates = SNDRV_PCM_RATE_8000_48000 | SNDRV_PCM_RATE_96000,
835 .formats = SGTL5000_FORMATS,
837 .ops = &sgtl5000_ops,
838 .symmetric_rates = 1,
841 static bool sgtl5000_volatile(struct device *dev, unsigned int reg)
843 switch (reg) {
844 case SGTL5000_CHIP_ID:
845 case SGTL5000_CHIP_ADCDAC_CTRL:
846 case SGTL5000_CHIP_ANA_STATUS:
847 return true;
850 return false;
853 static bool sgtl5000_readable(struct device *dev, unsigned int reg)
855 switch (reg) {
856 case SGTL5000_CHIP_ID:
857 case SGTL5000_CHIP_DIG_POWER:
858 case SGTL5000_CHIP_CLK_CTRL:
859 case SGTL5000_CHIP_I2S_CTRL:
860 case SGTL5000_CHIP_SSS_CTRL:
861 case SGTL5000_CHIP_ADCDAC_CTRL:
862 case SGTL5000_CHIP_DAC_VOL:
863 case SGTL5000_CHIP_PAD_STRENGTH:
864 case SGTL5000_CHIP_ANA_ADC_CTRL:
865 case SGTL5000_CHIP_ANA_HP_CTRL:
866 case SGTL5000_CHIP_ANA_CTRL:
867 case SGTL5000_CHIP_LINREG_CTRL:
868 case SGTL5000_CHIP_REF_CTRL:
869 case SGTL5000_CHIP_MIC_CTRL:
870 case SGTL5000_CHIP_LINE_OUT_CTRL:
871 case SGTL5000_CHIP_LINE_OUT_VOL:
872 case SGTL5000_CHIP_ANA_POWER:
873 case SGTL5000_CHIP_PLL_CTRL:
874 case SGTL5000_CHIP_CLK_TOP_CTRL:
875 case SGTL5000_CHIP_ANA_STATUS:
876 case SGTL5000_CHIP_SHORT_CTRL:
877 case SGTL5000_CHIP_ANA_TEST2:
878 case SGTL5000_DAP_CTRL:
879 case SGTL5000_DAP_PEQ:
880 case SGTL5000_DAP_BASS_ENHANCE:
881 case SGTL5000_DAP_BASS_ENHANCE_CTRL:
882 case SGTL5000_DAP_AUDIO_EQ:
883 case SGTL5000_DAP_SURROUND:
884 case SGTL5000_DAP_FLT_COEF_ACCESS:
885 case SGTL5000_DAP_COEF_WR_B0_MSB:
886 case SGTL5000_DAP_COEF_WR_B0_LSB:
887 case SGTL5000_DAP_EQ_BASS_BAND0:
888 case SGTL5000_DAP_EQ_BASS_BAND1:
889 case SGTL5000_DAP_EQ_BASS_BAND2:
890 case SGTL5000_DAP_EQ_BASS_BAND3:
891 case SGTL5000_DAP_EQ_BASS_BAND4:
892 case SGTL5000_DAP_MAIN_CHAN:
893 case SGTL5000_DAP_MIX_CHAN:
894 case SGTL5000_DAP_AVC_CTRL:
895 case SGTL5000_DAP_AVC_THRESHOLD:
896 case SGTL5000_DAP_AVC_ATTACK:
897 case SGTL5000_DAP_AVC_DECAY:
898 case SGTL5000_DAP_COEF_WR_B1_MSB:
899 case SGTL5000_DAP_COEF_WR_B1_LSB:
900 case SGTL5000_DAP_COEF_WR_B2_MSB:
901 case SGTL5000_DAP_COEF_WR_B2_LSB:
902 case SGTL5000_DAP_COEF_WR_A1_MSB:
903 case SGTL5000_DAP_COEF_WR_A1_LSB:
904 case SGTL5000_DAP_COEF_WR_A2_MSB:
905 case SGTL5000_DAP_COEF_WR_A2_LSB:
906 return true;
908 default:
909 return false;
914 * This precalculated table contains all (vag_val * 100 / lo_calcntrl) results
915 * to select an appropriate lo_vol_* in SGTL5000_CHIP_LINE_OUT_VOL
916 * The calculatation was done for all possible register values which
917 * is the array index and the following formula: 10^((idx−15)/40) * 100
919 static const u8 vol_quot_table[] = {
920 42, 45, 47, 50, 53, 56, 60, 63,
921 67, 71, 75, 79, 84, 89, 94, 100,
922 106, 112, 119, 126, 133, 141, 150, 158,
923 168, 178, 188, 200, 211, 224, 237, 251
927 * sgtl5000 has 3 internal power supplies:
928 * 1. VAG, normally set to vdda/2
929 * 2. charge pump, set to different value
930 * according to voltage of vdda and vddio
931 * 3. line out VAG, normally set to vddio/2
933 * and should be set according to:
934 * 1. vddd provided by external or not
935 * 2. vdda and vddio voltage value. > 3.1v or not
937 static int sgtl5000_set_power_regs(struct snd_soc_codec *codec)
939 int vddd;
940 int vdda;
941 int vddio;
942 u16 ana_pwr;
943 u16 lreg_ctrl;
944 int vag;
945 int lo_vag;
946 int vol_quot;
947 int lo_vol;
948 size_t i;
949 struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
951 vdda = regulator_get_voltage(sgtl5000->supplies[VDDA].consumer);
952 vddio = regulator_get_voltage(sgtl5000->supplies[VDDIO].consumer);
953 vddd = (sgtl5000->num_supplies > VDDD)
954 ? regulator_get_voltage(sgtl5000->supplies[VDDD].consumer)
955 : LDO_VOLTAGE;
957 vdda = vdda / 1000;
958 vddio = vddio / 1000;
959 vddd = vddd / 1000;
961 if (vdda <= 0 || vddio <= 0 || vddd < 0) {
962 dev_err(codec->dev, "regulator voltage not set correctly\n");
964 return -EINVAL;
967 /* according to datasheet, maximum voltage of supplies */
968 if (vdda > 3600 || vddio > 3600 || vddd > 1980) {
969 dev_err(codec->dev,
970 "exceed max voltage vdda %dmV vddio %dmV vddd %dmV\n",
971 vdda, vddio, vddd);
973 return -EINVAL;
976 /* reset value */
977 ana_pwr = snd_soc_read(codec, SGTL5000_CHIP_ANA_POWER);
978 ana_pwr |= SGTL5000_DAC_STEREO |
979 SGTL5000_ADC_STEREO |
980 SGTL5000_REFTOP_POWERUP;
981 lreg_ctrl = snd_soc_read(codec, SGTL5000_CHIP_LINREG_CTRL);
983 if (vddio < 3100 && vdda < 3100) {
984 /* enable internal oscillator used for charge pump */
985 snd_soc_update_bits(codec, SGTL5000_CHIP_CLK_TOP_CTRL,
986 SGTL5000_INT_OSC_EN,
987 SGTL5000_INT_OSC_EN);
988 /* Enable VDDC charge pump */
989 ana_pwr |= SGTL5000_VDDC_CHRGPMP_POWERUP;
990 } else if (vddio >= 3100 && vdda >= 3100) {
991 ana_pwr &= ~SGTL5000_VDDC_CHRGPMP_POWERUP;
992 /* VDDC use VDDIO rail */
993 lreg_ctrl |= SGTL5000_VDDC_ASSN_OVRD;
994 lreg_ctrl |= SGTL5000_VDDC_MAN_ASSN_VDDIO <<
995 SGTL5000_VDDC_MAN_ASSN_SHIFT;
998 snd_soc_write(codec, SGTL5000_CHIP_LINREG_CTRL, lreg_ctrl);
1000 snd_soc_write(codec, SGTL5000_CHIP_ANA_POWER, ana_pwr);
1003 * set ADC/DAC VAG to vdda / 2,
1004 * should stay in range (0.8v, 1.575v)
1006 vag = vdda / 2;
1007 if (vag <= SGTL5000_ANA_GND_BASE)
1008 vag = 0;
1009 else if (vag >= SGTL5000_ANA_GND_BASE + SGTL5000_ANA_GND_STP *
1010 (SGTL5000_ANA_GND_MASK >> SGTL5000_ANA_GND_SHIFT))
1011 vag = SGTL5000_ANA_GND_MASK >> SGTL5000_ANA_GND_SHIFT;
1012 else
1013 vag = (vag - SGTL5000_ANA_GND_BASE) / SGTL5000_ANA_GND_STP;
1015 snd_soc_update_bits(codec, SGTL5000_CHIP_REF_CTRL,
1016 SGTL5000_ANA_GND_MASK, vag << SGTL5000_ANA_GND_SHIFT);
1018 /* set line out VAG to vddio / 2, in range (0.8v, 1.675v) */
1019 lo_vag = vddio / 2;
1020 if (lo_vag <= SGTL5000_LINE_OUT_GND_BASE)
1021 lo_vag = 0;
1022 else if (lo_vag >= SGTL5000_LINE_OUT_GND_BASE +
1023 SGTL5000_LINE_OUT_GND_STP * SGTL5000_LINE_OUT_GND_MAX)
1024 lo_vag = SGTL5000_LINE_OUT_GND_MAX;
1025 else
1026 lo_vag = (lo_vag - SGTL5000_LINE_OUT_GND_BASE) /
1027 SGTL5000_LINE_OUT_GND_STP;
1029 snd_soc_update_bits(codec, SGTL5000_CHIP_LINE_OUT_CTRL,
1030 SGTL5000_LINE_OUT_CURRENT_MASK |
1031 SGTL5000_LINE_OUT_GND_MASK,
1032 lo_vag << SGTL5000_LINE_OUT_GND_SHIFT |
1033 SGTL5000_LINE_OUT_CURRENT_360u <<
1034 SGTL5000_LINE_OUT_CURRENT_SHIFT);
1037 * Set lineout output level in range (0..31)
1038 * the same value is used for right and left channel
1040 * Searching for a suitable index solving this formula:
1041 * idx = 40 * log10(vag_val / lo_cagcntrl) + 15
1043 vol_quot = (vag * 100) / lo_vag;
1044 lo_vol = 0;
1045 for (i = 0; i < ARRAY_SIZE(vol_quot_table); i++) {
1046 if (vol_quot >= vol_quot_table[i])
1047 lo_vol = i;
1048 else
1049 break;
1052 snd_soc_update_bits(codec, SGTL5000_CHIP_LINE_OUT_VOL,
1053 SGTL5000_LINE_OUT_VOL_RIGHT_MASK |
1054 SGTL5000_LINE_OUT_VOL_LEFT_MASK,
1055 lo_vol << SGTL5000_LINE_OUT_VOL_RIGHT_SHIFT |
1056 lo_vol << SGTL5000_LINE_OUT_VOL_LEFT_SHIFT);
1058 return 0;
1061 static int sgtl5000_enable_regulators(struct i2c_client *client)
1063 int ret;
1064 int i;
1065 int external_vddd = 0;
1066 struct regulator *vddd;
1067 struct sgtl5000_priv *sgtl5000 = i2c_get_clientdata(client);
1069 for (i = 0; i < ARRAY_SIZE(sgtl5000->supplies); i++)
1070 sgtl5000->supplies[i].supply = supply_names[i];
1072 vddd = regulator_get_optional(&client->dev, "VDDD");
1073 if (IS_ERR(vddd)) {
1074 /* See if it's just not registered yet */
1075 if (PTR_ERR(vddd) == -EPROBE_DEFER)
1076 return -EPROBE_DEFER;
1077 } else {
1078 external_vddd = 1;
1079 regulator_put(vddd);
1082 sgtl5000->num_supplies = ARRAY_SIZE(sgtl5000->supplies)
1083 - 1 + external_vddd;
1084 ret = regulator_bulk_get(&client->dev, sgtl5000->num_supplies,
1085 sgtl5000->supplies);
1086 if (ret)
1087 return ret;
1089 ret = regulator_bulk_enable(sgtl5000->num_supplies,
1090 sgtl5000->supplies);
1091 if (!ret)
1092 usleep_range(10, 20);
1093 else
1094 regulator_bulk_free(sgtl5000->num_supplies,
1095 sgtl5000->supplies);
1097 return ret;
1100 static int sgtl5000_probe(struct snd_soc_codec *codec)
1102 int ret;
1103 struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
1105 /* power up sgtl5000 */
1106 ret = sgtl5000_set_power_regs(codec);
1107 if (ret)
1108 goto err;
1110 /* enable small pop, introduce 400ms delay in turning off */
1111 snd_soc_update_bits(codec, SGTL5000_CHIP_REF_CTRL,
1112 SGTL5000_SMALL_POP, 1);
1114 /* disable short cut detector */
1115 snd_soc_write(codec, SGTL5000_CHIP_SHORT_CTRL, 0);
1118 * set i2s as default input of sound switch
1119 * TODO: add sound switch to control and dapm widge.
1121 snd_soc_write(codec, SGTL5000_CHIP_SSS_CTRL,
1122 SGTL5000_DAC_SEL_I2S_IN << SGTL5000_DAC_SEL_SHIFT);
1123 snd_soc_write(codec, SGTL5000_CHIP_DIG_POWER,
1124 SGTL5000_ADC_EN | SGTL5000_DAC_EN);
1126 /* enable dac volume ramp by default */
1127 snd_soc_write(codec, SGTL5000_CHIP_ADCDAC_CTRL,
1128 SGTL5000_DAC_VOL_RAMP_EN |
1129 SGTL5000_DAC_MUTE_RIGHT |
1130 SGTL5000_DAC_MUTE_LEFT);
1132 snd_soc_write(codec, SGTL5000_CHIP_PAD_STRENGTH, 0x015f);
1134 snd_soc_write(codec, SGTL5000_CHIP_ANA_CTRL,
1135 SGTL5000_HP_ZCD_EN |
1136 SGTL5000_ADC_ZCD_EN);
1138 snd_soc_update_bits(codec, SGTL5000_CHIP_MIC_CTRL,
1139 SGTL5000_BIAS_R_MASK,
1140 sgtl5000->micbias_resistor << SGTL5000_BIAS_R_SHIFT);
1142 snd_soc_update_bits(codec, SGTL5000_CHIP_MIC_CTRL,
1143 SGTL5000_BIAS_VOLT_MASK,
1144 sgtl5000->micbias_voltage << SGTL5000_BIAS_VOLT_SHIFT);
1146 * disable DAP
1147 * TODO:
1148 * Enable DAP in kcontrol and dapm.
1150 snd_soc_write(codec, SGTL5000_DAP_CTRL, 0);
1152 return 0;
1154 err:
1155 return ret;
1158 static int sgtl5000_remove(struct snd_soc_codec *codec)
1160 return 0;
1163 static struct snd_soc_codec_driver sgtl5000_driver = {
1164 .probe = sgtl5000_probe,
1165 .remove = sgtl5000_remove,
1166 .set_bias_level = sgtl5000_set_bias_level,
1167 .suspend_bias_off = true,
1168 .component_driver = {
1169 .controls = sgtl5000_snd_controls,
1170 .num_controls = ARRAY_SIZE(sgtl5000_snd_controls),
1171 .dapm_widgets = sgtl5000_dapm_widgets,
1172 .num_dapm_widgets = ARRAY_SIZE(sgtl5000_dapm_widgets),
1173 .dapm_routes = sgtl5000_dapm_routes,
1174 .num_dapm_routes = ARRAY_SIZE(sgtl5000_dapm_routes),
1178 static const struct regmap_config sgtl5000_regmap = {
1179 .reg_bits = 16,
1180 .val_bits = 16,
1181 .reg_stride = 2,
1183 .max_register = SGTL5000_MAX_REG_OFFSET,
1184 .volatile_reg = sgtl5000_volatile,
1185 .readable_reg = sgtl5000_readable,
1187 .cache_type = REGCACHE_RBTREE,
1188 .reg_defaults = sgtl5000_reg_defaults,
1189 .num_reg_defaults = ARRAY_SIZE(sgtl5000_reg_defaults),
1193 * Write all the default values from sgtl5000_reg_defaults[] array into the
1194 * sgtl5000 registers, to make sure we always start with the sane registers
1195 * values as stated in the datasheet.
1197 * Since sgtl5000 does not have a reset line, nor a reset command in software,
1198 * we follow this approach to guarantee we always start from the default values
1199 * and avoid problems like, not being able to probe after an audio playback
1200 * followed by a system reset or a 'reboot' command in Linux
1202 static void sgtl5000_fill_defaults(struct i2c_client *client)
1204 struct sgtl5000_priv *sgtl5000 = i2c_get_clientdata(client);
1205 int i, ret, val, index;
1207 for (i = 0; i < ARRAY_SIZE(sgtl5000_reg_defaults); i++) {
1208 val = sgtl5000_reg_defaults[i].def;
1209 index = sgtl5000_reg_defaults[i].reg;
1210 ret = regmap_write(sgtl5000->regmap, index, val);
1211 if (ret)
1212 dev_err(&client->dev,
1213 "%s: error %d setting reg 0x%02x to 0x%04x\n",
1214 __func__, ret, index, val);
1218 static int sgtl5000_i2c_probe(struct i2c_client *client,
1219 const struct i2c_device_id *id)
1221 struct sgtl5000_priv *sgtl5000;
1222 int ret, reg, rev;
1223 struct device_node *np = client->dev.of_node;
1224 u32 value;
1225 u16 ana_pwr;
1227 sgtl5000 = devm_kzalloc(&client->dev, sizeof(*sgtl5000), GFP_KERNEL);
1228 if (!sgtl5000)
1229 return -ENOMEM;
1231 i2c_set_clientdata(client, sgtl5000);
1233 ret = sgtl5000_enable_regulators(client);
1234 if (ret)
1235 return ret;
1237 sgtl5000->regmap = devm_regmap_init_i2c(client, &sgtl5000_regmap);
1238 if (IS_ERR(sgtl5000->regmap)) {
1239 ret = PTR_ERR(sgtl5000->regmap);
1240 dev_err(&client->dev, "Failed to allocate regmap: %d\n", ret);
1241 goto disable_regs;
1244 sgtl5000->mclk = devm_clk_get(&client->dev, NULL);
1245 if (IS_ERR(sgtl5000->mclk)) {
1246 ret = PTR_ERR(sgtl5000->mclk);
1247 dev_err(&client->dev, "Failed to get mclock: %d\n", ret);
1248 /* Defer the probe to see if the clk will be provided later */
1249 if (ret == -ENOENT)
1250 ret = -EPROBE_DEFER;
1251 goto disable_regs;
1254 ret = clk_prepare_enable(sgtl5000->mclk);
1255 if (ret) {
1256 dev_err(&client->dev, "Error enabling clock %d\n", ret);
1257 goto disable_regs;
1260 /* Need 8 clocks before I2C accesses */
1261 udelay(1);
1263 /* read chip information */
1264 ret = regmap_read(sgtl5000->regmap, SGTL5000_CHIP_ID, &reg);
1265 if (ret) {
1266 dev_err(&client->dev, "Error reading chip id %d\n", ret);
1267 goto disable_clk;
1270 if (((reg & SGTL5000_PARTID_MASK) >> SGTL5000_PARTID_SHIFT) !=
1271 SGTL5000_PARTID_PART_ID) {
1272 dev_err(&client->dev,
1273 "Device with ID register %x is not a sgtl5000\n", reg);
1274 ret = -ENODEV;
1275 goto disable_clk;
1278 rev = (reg & SGTL5000_REVID_MASK) >> SGTL5000_REVID_SHIFT;
1279 dev_info(&client->dev, "sgtl5000 revision 0x%x\n", rev);
1280 sgtl5000->revision = rev;
1282 /* reconfigure the clocks in case we're using the PLL */
1283 ret = regmap_write(sgtl5000->regmap,
1284 SGTL5000_CHIP_CLK_CTRL,
1285 SGTL5000_CHIP_CLK_CTRL_DEFAULT);
1286 if (ret)
1287 dev_err(&client->dev,
1288 "Error %d initializing CHIP_CLK_CTRL\n", ret);
1290 /* Follow section 2.2.1.1 of AN3663 */
1291 ana_pwr = SGTL5000_ANA_POWER_DEFAULT;
1292 if (sgtl5000->num_supplies <= VDDD) {
1293 /* internal VDDD at 1.2V */
1294 ret = regmap_update_bits(sgtl5000->regmap,
1295 SGTL5000_CHIP_LINREG_CTRL,
1296 SGTL5000_LINREG_VDDD_MASK,
1297 LINREG_VDDD);
1298 if (ret)
1299 dev_err(&client->dev,
1300 "Error %d setting LINREG_VDDD\n", ret);
1302 ana_pwr |= SGTL5000_LINEREG_D_POWERUP;
1303 dev_info(&client->dev,
1304 "Using internal LDO instead of VDDD: check ER1\n");
1305 } else {
1306 /* using external LDO for VDDD
1307 * Clear startup powerup and simple powerup
1308 * bits to save power
1310 ana_pwr &= ~(SGTL5000_STARTUP_POWERUP
1311 | SGTL5000_LINREG_SIMPLE_POWERUP);
1312 dev_dbg(&client->dev, "Using external VDDD\n");
1314 ret = regmap_write(sgtl5000->regmap, SGTL5000_CHIP_ANA_POWER, ana_pwr);
1315 if (ret)
1316 dev_err(&client->dev,
1317 "Error %d setting CHIP_ANA_POWER to %04x\n",
1318 ret, ana_pwr);
1320 if (np) {
1321 if (!of_property_read_u32(np,
1322 "micbias-resistor-k-ohms", &value)) {
1323 switch (value) {
1324 case SGTL5000_MICBIAS_OFF:
1325 sgtl5000->micbias_resistor = 0;
1326 break;
1327 case SGTL5000_MICBIAS_2K:
1328 sgtl5000->micbias_resistor = 1;
1329 break;
1330 case SGTL5000_MICBIAS_4K:
1331 sgtl5000->micbias_resistor = 2;
1332 break;
1333 case SGTL5000_MICBIAS_8K:
1334 sgtl5000->micbias_resistor = 3;
1335 break;
1336 default:
1337 sgtl5000->micbias_resistor = 2;
1338 dev_err(&client->dev,
1339 "Unsuitable MicBias resistor\n");
1341 } else {
1342 /* default is 4Kohms */
1343 sgtl5000->micbias_resistor = 2;
1345 if (!of_property_read_u32(np,
1346 "micbias-voltage-m-volts", &value)) {
1347 /* 1250mV => 0 */
1348 /* steps of 250mV */
1349 if ((value >= 1250) && (value <= 3000))
1350 sgtl5000->micbias_voltage = (value / 250) - 5;
1351 else {
1352 sgtl5000->micbias_voltage = 0;
1353 dev_err(&client->dev,
1354 "Unsuitable MicBias voltage\n");
1356 } else {
1357 sgtl5000->micbias_voltage = 0;
1361 /* Ensure sgtl5000 will start with sane register values */
1362 sgtl5000_fill_defaults(client);
1364 ret = snd_soc_register_codec(&client->dev,
1365 &sgtl5000_driver, &sgtl5000_dai, 1);
1366 if (ret)
1367 goto disable_clk;
1369 return 0;
1371 disable_clk:
1372 clk_disable_unprepare(sgtl5000->mclk);
1374 disable_regs:
1375 regulator_bulk_disable(sgtl5000->num_supplies, sgtl5000->supplies);
1376 regulator_bulk_free(sgtl5000->num_supplies, sgtl5000->supplies);
1378 return ret;
1381 static int sgtl5000_i2c_remove(struct i2c_client *client)
1383 struct sgtl5000_priv *sgtl5000 = i2c_get_clientdata(client);
1385 snd_soc_unregister_codec(&client->dev);
1386 clk_disable_unprepare(sgtl5000->mclk);
1387 regulator_bulk_disable(sgtl5000->num_supplies, sgtl5000->supplies);
1388 regulator_bulk_free(sgtl5000->num_supplies, sgtl5000->supplies);
1390 return 0;
1393 static const struct i2c_device_id sgtl5000_id[] = {
1394 {"sgtl5000", 0},
1398 MODULE_DEVICE_TABLE(i2c, sgtl5000_id);
1400 static const struct of_device_id sgtl5000_dt_ids[] = {
1401 { .compatible = "fsl,sgtl5000", },
1402 { /* sentinel */ }
1404 MODULE_DEVICE_TABLE(of, sgtl5000_dt_ids);
1406 static struct i2c_driver sgtl5000_i2c_driver = {
1407 .driver = {
1408 .name = "sgtl5000",
1409 .of_match_table = sgtl5000_dt_ids,
1411 .probe = sgtl5000_i2c_probe,
1412 .remove = sgtl5000_i2c_remove,
1413 .id_table = sgtl5000_id,
1416 module_i2c_driver(sgtl5000_i2c_driver);
1418 MODULE_DESCRIPTION("Freescale SGTL5000 ALSA SoC Codec Driver");
1419 MODULE_AUTHOR("Zeng Zhaoming <zengzm.kernel@gmail.com>");
1420 MODULE_LICENSE("GPL");