sgtl5000.c 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626
  1. /*
  2. * sgtl5000.c -- SGTL5000 ALSA SoC Audio driver
  3. *
  4. * Copyright 2010-2011 Freescale Semiconductor, Inc. All Rights Reserved.
  5. *
  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. */
  10. #include <linux/module.h>
  11. #include <linux/moduleparam.h>
  12. #include <linux/init.h>
  13. #include <linux/delay.h>
  14. #include <linux/slab.h>
  15. #include <linux/pm.h>
  16. #include <linux/i2c.h>
  17. #include <linux/clk.h>
  18. #include <linux/regmap.h>
  19. #include <linux/regulator/driver.h>
  20. #include <linux/regulator/machine.h>
  21. #include <linux/regulator/consumer.h>
  22. #include <linux/of_device.h>
  23. #include <sound/core.h>
  24. #include <sound/tlv.h>
  25. #include <sound/pcm.h>
  26. #include <sound/pcm_params.h>
  27. #include <sound/soc.h>
  28. #include <sound/soc-dapm.h>
  29. #include <sound/initval.h>
  30. #include "sgtl5000.h"
  31. #define SGTL5000_DAP_REG_OFFSET 0x0100
  32. #define SGTL5000_MAX_REG_OFFSET 0x013A
  33. /* default value of sgtl5000 registers */
  34. static const struct reg_default sgtl5000_reg_defaults[] = {
  35. { SGTL5000_CHIP_CLK_CTRL, 0x0008 },
  36. { SGTL5000_CHIP_I2S_CTRL, 0x0010 },
  37. { SGTL5000_CHIP_SSS_CTRL, 0x0010 },
  38. { SGTL5000_CHIP_DAC_VOL, 0x3c3c },
  39. { SGTL5000_CHIP_PAD_STRENGTH, 0x015f },
  40. { SGTL5000_CHIP_ANA_HP_CTRL, 0x1818 },
  41. { SGTL5000_CHIP_ANA_CTRL, 0x0111 },
  42. { SGTL5000_CHIP_LINE_OUT_VOL, 0x0404 },
  43. { SGTL5000_CHIP_ANA_POWER, 0x7060 },
  44. { SGTL5000_CHIP_PLL_CTRL, 0x5000 },
  45. { SGTL5000_DAP_BASS_ENHANCE, 0x0040 },
  46. { SGTL5000_DAP_BASS_ENHANCE_CTRL, 0x051f },
  47. { SGTL5000_DAP_SURROUND, 0x0040 },
  48. { SGTL5000_DAP_EQ_BASS_BAND0, 0x002f },
  49. { SGTL5000_DAP_EQ_BASS_BAND1, 0x002f },
  50. { SGTL5000_DAP_EQ_BASS_BAND2, 0x002f },
  51. { SGTL5000_DAP_EQ_BASS_BAND3, 0x002f },
  52. { SGTL5000_DAP_EQ_BASS_BAND4, 0x002f },
  53. { SGTL5000_DAP_MAIN_CHAN, 0x8000 },
  54. { SGTL5000_DAP_AVC_CTRL, 0x0510 },
  55. { SGTL5000_DAP_AVC_THRESHOLD, 0x1473 },
  56. { SGTL5000_DAP_AVC_ATTACK, 0x0028 },
  57. { SGTL5000_DAP_AVC_DECAY, 0x0050 },
  58. };
  59. /* regulator supplies for sgtl5000, VDDD is an optional external supply */
  60. enum sgtl5000_regulator_supplies {
  61. VDDA,
  62. VDDIO,
  63. VDDD,
  64. SGTL5000_SUPPLY_NUM
  65. };
  66. /* vddd is optional supply */
  67. static const char *supply_names[SGTL5000_SUPPLY_NUM] = {
  68. "VDDA",
  69. "VDDIO",
  70. "VDDD"
  71. };
  72. #define LDO_CONSUMER_NAME "VDDD_LDO"
  73. #define LDO_VOLTAGE 1200000
  74. static struct regulator_consumer_supply ldo_consumer[] = {
  75. REGULATOR_SUPPLY(LDO_CONSUMER_NAME, NULL),
  76. };
  77. static struct regulator_init_data ldo_init_data = {
  78. .constraints = {
  79. .min_uV = 1200000,
  80. .max_uV = 1200000,
  81. .valid_modes_mask = REGULATOR_MODE_NORMAL,
  82. .valid_ops_mask = REGULATOR_CHANGE_STATUS,
  83. },
  84. .num_consumer_supplies = 1,
  85. .consumer_supplies = &ldo_consumer[0],
  86. };
  87. /*
  88. * sgtl5000 internal ldo regulator,
  89. * enabled when VDDD not provided
  90. */
  91. struct ldo_regulator {
  92. struct regulator_desc desc;
  93. struct regulator_dev *dev;
  94. int voltage;
  95. void *codec_data;
  96. bool enabled;
  97. };
  98. /* sgtl5000 private structure in codec */
  99. struct sgtl5000_priv {
  100. int sysclk; /* sysclk rate */
  101. int master; /* i2s master or not */
  102. int fmt; /* i2s data format */
  103. struct regulator_bulk_data supplies[SGTL5000_SUPPLY_NUM];
  104. struct ldo_regulator *ldo;
  105. struct regmap *regmap;
  106. struct clk *mclk;
  107. };
  108. /*
  109. * mic_bias power on/off share the same register bits with
  110. * output impedance of mic bias, when power on mic bias, we
  111. * need reclaim it to impedance value.
  112. * 0x0 = Powered off
  113. * 0x1 = 2Kohm
  114. * 0x2 = 4Kohm
  115. * 0x3 = 8Kohm
  116. */
  117. static int mic_bias_event(struct snd_soc_dapm_widget *w,
  118. struct snd_kcontrol *kcontrol, int event)
  119. {
  120. switch (event) {
  121. case SND_SOC_DAPM_POST_PMU:
  122. /* change mic bias resistor to 4Kohm */
  123. snd_soc_update_bits(w->codec, SGTL5000_CHIP_MIC_CTRL,
  124. SGTL5000_BIAS_R_MASK,
  125. SGTL5000_BIAS_R_4k << SGTL5000_BIAS_R_SHIFT);
  126. break;
  127. case SND_SOC_DAPM_PRE_PMD:
  128. snd_soc_update_bits(w->codec, SGTL5000_CHIP_MIC_CTRL,
  129. SGTL5000_BIAS_R_MASK, 0);
  130. break;
  131. }
  132. return 0;
  133. }
  134. /*
  135. * As manual described, ADC/DAC only works when VAG powerup,
  136. * So enabled VAG before ADC/DAC up.
  137. * In power down case, we need wait 400ms when vag fully ramped down.
  138. */
  139. static int power_vag_event(struct snd_soc_dapm_widget *w,
  140. struct snd_kcontrol *kcontrol, int event)
  141. {
  142. const u32 mask = SGTL5000_DAC_POWERUP | SGTL5000_ADC_POWERUP;
  143. switch (event) {
  144. case SND_SOC_DAPM_POST_PMU:
  145. snd_soc_update_bits(w->codec, SGTL5000_CHIP_ANA_POWER,
  146. SGTL5000_VAG_POWERUP, SGTL5000_VAG_POWERUP);
  147. break;
  148. case SND_SOC_DAPM_PRE_PMD:
  149. /*
  150. * Don't clear VAG_POWERUP, when both DAC and ADC are
  151. * operational to prevent inadvertently starving the
  152. * other one of them.
  153. */
  154. if ((snd_soc_read(w->codec, SGTL5000_CHIP_ANA_POWER) &
  155. mask) != mask) {
  156. snd_soc_update_bits(w->codec, SGTL5000_CHIP_ANA_POWER,
  157. SGTL5000_VAG_POWERUP, 0);
  158. msleep(400);
  159. }
  160. break;
  161. default:
  162. break;
  163. }
  164. return 0;
  165. }
  166. /* input sources for ADC */
  167. static const char *adc_mux_text[] = {
  168. "MIC_IN", "LINE_IN"
  169. };
  170. static const struct soc_enum adc_enum =
  171. SOC_ENUM_SINGLE(SGTL5000_CHIP_ANA_CTRL, 2, 2, adc_mux_text);
  172. static const struct snd_kcontrol_new adc_mux =
  173. SOC_DAPM_ENUM("Capture Mux", adc_enum);
  174. /* input sources for DAC */
  175. static const char *dac_mux_text[] = {
  176. "DAC", "LINE_IN"
  177. };
  178. static const struct soc_enum dac_enum =
  179. SOC_ENUM_SINGLE(SGTL5000_CHIP_ANA_CTRL, 6, 2, dac_mux_text);
  180. static const struct snd_kcontrol_new dac_mux =
  181. SOC_DAPM_ENUM("Headphone Mux", dac_enum);
  182. static const struct snd_soc_dapm_widget sgtl5000_dapm_widgets[] = {
  183. SND_SOC_DAPM_INPUT("LINE_IN"),
  184. SND_SOC_DAPM_INPUT("MIC_IN"),
  185. SND_SOC_DAPM_OUTPUT("HP_OUT"),
  186. SND_SOC_DAPM_OUTPUT("LINE_OUT"),
  187. SND_SOC_DAPM_SUPPLY("Mic Bias", SGTL5000_CHIP_MIC_CTRL, 8, 0,
  188. mic_bias_event,
  189. SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD),
  190. SND_SOC_DAPM_PGA("HP", SGTL5000_CHIP_ANA_POWER, 4, 0, NULL, 0),
  191. SND_SOC_DAPM_PGA("LO", SGTL5000_CHIP_ANA_POWER, 0, 0, NULL, 0),
  192. SND_SOC_DAPM_MUX("Capture Mux", SND_SOC_NOPM, 0, 0, &adc_mux),
  193. SND_SOC_DAPM_MUX("Headphone Mux", SND_SOC_NOPM, 0, 0, &dac_mux),
  194. /* aif for i2s input */
  195. SND_SOC_DAPM_AIF_IN("AIFIN", "Playback",
  196. 0, SGTL5000_CHIP_DIG_POWER,
  197. 0, 0),
  198. /* aif for i2s output */
  199. SND_SOC_DAPM_AIF_OUT("AIFOUT", "Capture",
  200. 0, SGTL5000_CHIP_DIG_POWER,
  201. 1, 0),
  202. SND_SOC_DAPM_ADC("ADC", "Capture", SGTL5000_CHIP_ANA_POWER, 1, 0),
  203. SND_SOC_DAPM_DAC("DAC", "Playback", SGTL5000_CHIP_ANA_POWER, 3, 0),
  204. SND_SOC_DAPM_PRE("VAG_POWER_PRE", power_vag_event),
  205. SND_SOC_DAPM_POST("VAG_POWER_POST", power_vag_event),
  206. };
  207. /* routes for sgtl5000 */
  208. static const struct snd_soc_dapm_route sgtl5000_dapm_routes[] = {
  209. {"Capture Mux", "LINE_IN", "LINE_IN"}, /* line_in --> adc_mux */
  210. {"Capture Mux", "MIC_IN", "MIC_IN"}, /* mic_in --> adc_mux */
  211. {"ADC", NULL, "Capture Mux"}, /* adc_mux --> adc */
  212. {"AIFOUT", NULL, "ADC"}, /* adc --> i2s_out */
  213. {"DAC", NULL, "AIFIN"}, /* i2s-->dac,skip audio mux */
  214. {"Headphone Mux", "DAC", "DAC"}, /* dac --> hp_mux */
  215. {"LO", NULL, "DAC"}, /* dac --> line_out */
  216. {"Headphone Mux", "LINE_IN", "LINE_IN"},/* line_in --> hp_mux */
  217. {"HP", NULL, "Headphone Mux"}, /* hp_mux --> hp */
  218. {"LINE_OUT", NULL, "LO"},
  219. {"HP_OUT", NULL, "HP"},
  220. };
  221. /* custom function to fetch info of PCM playback volume */
  222. static int dac_info_volsw(struct snd_kcontrol *kcontrol,
  223. struct snd_ctl_elem_info *uinfo)
  224. {
  225. uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
  226. uinfo->count = 2;
  227. uinfo->value.integer.min = 0;
  228. uinfo->value.integer.max = 0xfc - 0x3c;
  229. return 0;
  230. }
  231. /*
  232. * custom function to get of PCM playback volume
  233. *
  234. * dac volume register
  235. * 15-------------8-7--------------0
  236. * | R channel vol | L channel vol |
  237. * -------------------------------
  238. *
  239. * PCM volume with 0.5017 dB steps from 0 to -90 dB
  240. *
  241. * register values map to dB
  242. * 0x3B and less = Reserved
  243. * 0x3C = 0 dB
  244. * 0x3D = -0.5 dB
  245. * 0xF0 = -90 dB
  246. * 0xFC and greater = Muted
  247. *
  248. * register value map to userspace value
  249. *
  250. * register value 0x3c(0dB) 0xf0(-90dB)0xfc
  251. * ------------------------------
  252. * userspace value 0xc0 0
  253. */
  254. static int dac_get_volsw(struct snd_kcontrol *kcontrol,
  255. struct snd_ctl_elem_value *ucontrol)
  256. {
  257. struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
  258. int reg;
  259. int l;
  260. int r;
  261. reg = snd_soc_read(codec, SGTL5000_CHIP_DAC_VOL);
  262. /* get left channel volume */
  263. l = (reg & SGTL5000_DAC_VOL_LEFT_MASK) >> SGTL5000_DAC_VOL_LEFT_SHIFT;
  264. /* get right channel volume */
  265. r = (reg & SGTL5000_DAC_VOL_RIGHT_MASK) >> SGTL5000_DAC_VOL_RIGHT_SHIFT;
  266. /* make sure value fall in (0x3c,0xfc) */
  267. l = clamp(l, 0x3c, 0xfc);
  268. r = clamp(r, 0x3c, 0xfc);
  269. /* invert it and map to userspace value */
  270. l = 0xfc - l;
  271. r = 0xfc - r;
  272. ucontrol->value.integer.value[0] = l;
  273. ucontrol->value.integer.value[1] = r;
  274. return 0;
  275. }
  276. /*
  277. * custom function to put of PCM playback volume
  278. *
  279. * dac volume register
  280. * 15-------------8-7--------------0
  281. * | R channel vol | L channel vol |
  282. * -------------------------------
  283. *
  284. * PCM volume with 0.5017 dB steps from 0 to -90 dB
  285. *
  286. * register values map to dB
  287. * 0x3B and less = Reserved
  288. * 0x3C = 0 dB
  289. * 0x3D = -0.5 dB
  290. * 0xF0 = -90 dB
  291. * 0xFC and greater = Muted
  292. *
  293. * userspace value map to register value
  294. *
  295. * userspace value 0xc0 0
  296. * ------------------------------
  297. * register value 0x3c(0dB) 0xf0(-90dB)0xfc
  298. */
  299. static int dac_put_volsw(struct snd_kcontrol *kcontrol,
  300. struct snd_ctl_elem_value *ucontrol)
  301. {
  302. struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
  303. int reg;
  304. int l;
  305. int r;
  306. l = ucontrol->value.integer.value[0];
  307. r = ucontrol->value.integer.value[1];
  308. /* make sure userspace volume fall in (0, 0xfc-0x3c) */
  309. l = clamp(l, 0, 0xfc - 0x3c);
  310. r = clamp(r, 0, 0xfc - 0x3c);
  311. /* invert it, get the value can be set to register */
  312. l = 0xfc - l;
  313. r = 0xfc - r;
  314. /* shift to get the register value */
  315. reg = l << SGTL5000_DAC_VOL_LEFT_SHIFT |
  316. r << SGTL5000_DAC_VOL_RIGHT_SHIFT;
  317. snd_soc_write(codec, SGTL5000_CHIP_DAC_VOL, reg);
  318. return 0;
  319. }
  320. static const DECLARE_TLV_DB_SCALE(capture_6db_attenuate, -600, 600, 0);
  321. /* tlv for mic gain, 0db 20db 30db 40db */
  322. static const unsigned int mic_gain_tlv[] = {
  323. TLV_DB_RANGE_HEAD(2),
  324. 0, 0, TLV_DB_SCALE_ITEM(0, 0, 0),
  325. 1, 3, TLV_DB_SCALE_ITEM(2000, 1000, 0),
  326. };
  327. /* tlv for hp volume, -51.5db to 12.0db, step .5db */
  328. static const DECLARE_TLV_DB_SCALE(headphone_volume, -5150, 50, 0);
  329. static const struct snd_kcontrol_new sgtl5000_snd_controls[] = {
  330. /* SOC_DOUBLE_S8_TLV with invert */
  331. {
  332. .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
  333. .name = "PCM Playback Volume",
  334. .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |
  335. SNDRV_CTL_ELEM_ACCESS_READWRITE,
  336. .info = dac_info_volsw,
  337. .get = dac_get_volsw,
  338. .put = dac_put_volsw,
  339. },
  340. SOC_DOUBLE("Capture Volume", SGTL5000_CHIP_ANA_ADC_CTRL, 0, 4, 0xf, 0),
  341. SOC_SINGLE_TLV("Capture Attenuate Switch (-6dB)",
  342. SGTL5000_CHIP_ANA_ADC_CTRL,
  343. 8, 1, 0, capture_6db_attenuate),
  344. SOC_SINGLE("Capture ZC Switch", SGTL5000_CHIP_ANA_CTRL, 1, 1, 0),
  345. SOC_DOUBLE_TLV("Headphone Playback Volume",
  346. SGTL5000_CHIP_ANA_HP_CTRL,
  347. 0, 8,
  348. 0x7f, 1,
  349. headphone_volume),
  350. SOC_SINGLE("Headphone Playback ZC Switch", SGTL5000_CHIP_ANA_CTRL,
  351. 5, 1, 0),
  352. SOC_SINGLE_TLV("Mic Volume", SGTL5000_CHIP_MIC_CTRL,
  353. 0, 3, 0, mic_gain_tlv),
  354. };
  355. /* mute the codec used by alsa core */
  356. static int sgtl5000_digital_mute(struct snd_soc_dai *codec_dai, int mute)
  357. {
  358. struct snd_soc_codec *codec = codec_dai->codec;
  359. u16 adcdac_ctrl = SGTL5000_DAC_MUTE_LEFT | SGTL5000_DAC_MUTE_RIGHT;
  360. snd_soc_update_bits(codec, SGTL5000_CHIP_ADCDAC_CTRL,
  361. adcdac_ctrl, mute ? adcdac_ctrl : 0);
  362. return 0;
  363. }
  364. /* set codec format */
  365. static int sgtl5000_set_dai_fmt(struct snd_soc_dai *codec_dai, unsigned int fmt)
  366. {
  367. struct snd_soc_codec *codec = codec_dai->codec;
  368. struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
  369. u16 i2sctl = 0;
  370. sgtl5000->master = 0;
  371. /*
  372. * i2s clock and frame master setting.
  373. * ONLY support:
  374. * - clock and frame slave,
  375. * - clock and frame master
  376. */
  377. switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
  378. case SND_SOC_DAIFMT_CBS_CFS:
  379. break;
  380. case SND_SOC_DAIFMT_CBM_CFM:
  381. i2sctl |= SGTL5000_I2S_MASTER;
  382. sgtl5000->master = 1;
  383. break;
  384. default:
  385. return -EINVAL;
  386. }
  387. /* setting i2s data format */
  388. switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
  389. case SND_SOC_DAIFMT_DSP_A:
  390. i2sctl |= SGTL5000_I2S_MODE_PCM;
  391. break;
  392. case SND_SOC_DAIFMT_DSP_B:
  393. i2sctl |= SGTL5000_I2S_MODE_PCM;
  394. i2sctl |= SGTL5000_I2S_LRALIGN;
  395. break;
  396. case SND_SOC_DAIFMT_I2S:
  397. i2sctl |= SGTL5000_I2S_MODE_I2S_LJ;
  398. break;
  399. case SND_SOC_DAIFMT_RIGHT_J:
  400. i2sctl |= SGTL5000_I2S_MODE_RJ;
  401. i2sctl |= SGTL5000_I2S_LRPOL;
  402. break;
  403. case SND_SOC_DAIFMT_LEFT_J:
  404. i2sctl |= SGTL5000_I2S_MODE_I2S_LJ;
  405. i2sctl |= SGTL5000_I2S_LRALIGN;
  406. break;
  407. default:
  408. return -EINVAL;
  409. }
  410. sgtl5000->fmt = fmt & SND_SOC_DAIFMT_FORMAT_MASK;
  411. /* Clock inversion */
  412. switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
  413. case SND_SOC_DAIFMT_NB_NF:
  414. break;
  415. case SND_SOC_DAIFMT_IB_NF:
  416. i2sctl |= SGTL5000_I2S_SCLK_INV;
  417. break;
  418. default:
  419. return -EINVAL;
  420. }
  421. snd_soc_write(codec, SGTL5000_CHIP_I2S_CTRL, i2sctl);
  422. return 0;
  423. }
  424. /* set codec sysclk */
  425. static int sgtl5000_set_dai_sysclk(struct snd_soc_dai *codec_dai,
  426. int clk_id, unsigned int freq, int dir)
  427. {
  428. struct snd_soc_codec *codec = codec_dai->codec;
  429. struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
  430. switch (clk_id) {
  431. case SGTL5000_SYSCLK:
  432. sgtl5000->sysclk = freq;
  433. break;
  434. default:
  435. return -EINVAL;
  436. }
  437. return 0;
  438. }
  439. /*
  440. * set clock according to i2s frame clock,
  441. * sgtl5000 provide 2 clock sources.
  442. * 1. sys_mclk. sample freq can only configure to
  443. * 1/256, 1/384, 1/512 of sys_mclk.
  444. * 2. pll. can derive any audio clocks.
  445. *
  446. * clock setting rules:
  447. * 1. in slave mode, only sys_mclk can use.
  448. * 2. as constraint by sys_mclk, sample freq should
  449. * set to 32k, 44.1k and above.
  450. * 3. using sys_mclk prefer to pll to save power.
  451. */
  452. static int sgtl5000_set_clock(struct snd_soc_codec *codec, int frame_rate)
  453. {
  454. struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
  455. int clk_ctl = 0;
  456. int sys_fs; /* sample freq */
  457. /*
  458. * sample freq should be divided by frame clock,
  459. * if frame clock lower than 44.1khz, sample feq should set to
  460. * 32khz or 44.1khz.
  461. */
  462. switch (frame_rate) {
  463. case 8000:
  464. case 16000:
  465. sys_fs = 32000;
  466. break;
  467. case 11025:
  468. case 22050:
  469. sys_fs = 44100;
  470. break;
  471. default:
  472. sys_fs = frame_rate;
  473. break;
  474. }
  475. /* set divided factor of frame clock */
  476. switch (sys_fs / frame_rate) {
  477. case 4:
  478. clk_ctl |= SGTL5000_RATE_MODE_DIV_4 << SGTL5000_RATE_MODE_SHIFT;
  479. break;
  480. case 2:
  481. clk_ctl |= SGTL5000_RATE_MODE_DIV_2 << SGTL5000_RATE_MODE_SHIFT;
  482. break;
  483. case 1:
  484. clk_ctl |= SGTL5000_RATE_MODE_DIV_1 << SGTL5000_RATE_MODE_SHIFT;
  485. break;
  486. default:
  487. return -EINVAL;
  488. }
  489. /* set the sys_fs according to frame rate */
  490. switch (sys_fs) {
  491. case 32000:
  492. clk_ctl |= SGTL5000_SYS_FS_32k << SGTL5000_SYS_FS_SHIFT;
  493. break;
  494. case 44100:
  495. clk_ctl |= SGTL5000_SYS_FS_44_1k << SGTL5000_SYS_FS_SHIFT;
  496. break;
  497. case 48000:
  498. clk_ctl |= SGTL5000_SYS_FS_48k << SGTL5000_SYS_FS_SHIFT;
  499. break;
  500. case 96000:
  501. clk_ctl |= SGTL5000_SYS_FS_96k << SGTL5000_SYS_FS_SHIFT;
  502. break;
  503. default:
  504. dev_err(codec->dev, "frame rate %d not supported\n",
  505. frame_rate);
  506. return -EINVAL;
  507. }
  508. /*
  509. * calculate the divider of mclk/sample_freq,
  510. * factor of freq =96k can only be 256, since mclk in range (12m,27m)
  511. */
  512. switch (sgtl5000->sysclk / sys_fs) {
  513. case 256:
  514. clk_ctl |= SGTL5000_MCLK_FREQ_256FS <<
  515. SGTL5000_MCLK_FREQ_SHIFT;
  516. break;
  517. case 384:
  518. clk_ctl |= SGTL5000_MCLK_FREQ_384FS <<
  519. SGTL5000_MCLK_FREQ_SHIFT;
  520. break;
  521. case 512:
  522. clk_ctl |= SGTL5000_MCLK_FREQ_512FS <<
  523. SGTL5000_MCLK_FREQ_SHIFT;
  524. break;
  525. default:
  526. /* if mclk not satisify the divider, use pll */
  527. if (sgtl5000->master) {
  528. clk_ctl |= SGTL5000_MCLK_FREQ_PLL <<
  529. SGTL5000_MCLK_FREQ_SHIFT;
  530. } else {
  531. dev_err(codec->dev,
  532. "PLL not supported in slave mode\n");
  533. return -EINVAL;
  534. }
  535. }
  536. /* if using pll, please check manual 6.4.2 for detail */
  537. if ((clk_ctl & SGTL5000_MCLK_FREQ_MASK) == SGTL5000_MCLK_FREQ_PLL) {
  538. u64 out, t;
  539. int div2;
  540. int pll_ctl;
  541. unsigned int in, int_div, frac_div;
  542. if (sgtl5000->sysclk > 17000000) {
  543. div2 = 1;
  544. in = sgtl5000->sysclk / 2;
  545. } else {
  546. div2 = 0;
  547. in = sgtl5000->sysclk;
  548. }
  549. if (sys_fs == 44100)
  550. out = 180633600;
  551. else
  552. out = 196608000;
  553. t = do_div(out, in);
  554. int_div = out;
  555. t *= 2048;
  556. do_div(t, in);
  557. frac_div = t;
  558. pll_ctl = int_div << SGTL5000_PLL_INT_DIV_SHIFT |
  559. frac_div << SGTL5000_PLL_FRAC_DIV_SHIFT;
  560. snd_soc_write(codec, SGTL5000_CHIP_PLL_CTRL, pll_ctl);
  561. if (div2)
  562. snd_soc_update_bits(codec,
  563. SGTL5000_CHIP_CLK_TOP_CTRL,
  564. SGTL5000_INPUT_FREQ_DIV2,
  565. SGTL5000_INPUT_FREQ_DIV2);
  566. else
  567. snd_soc_update_bits(codec,
  568. SGTL5000_CHIP_CLK_TOP_CTRL,
  569. SGTL5000_INPUT_FREQ_DIV2,
  570. 0);
  571. /* power up pll */
  572. snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
  573. SGTL5000_PLL_POWERUP | SGTL5000_VCOAMP_POWERUP,
  574. SGTL5000_PLL_POWERUP | SGTL5000_VCOAMP_POWERUP);
  575. /* if using pll, clk_ctrl must be set after pll power up */
  576. snd_soc_write(codec, SGTL5000_CHIP_CLK_CTRL, clk_ctl);
  577. } else {
  578. /* otherwise, clk_ctrl must be set before pll power down */
  579. snd_soc_write(codec, SGTL5000_CHIP_CLK_CTRL, clk_ctl);
  580. /* power down pll */
  581. snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
  582. SGTL5000_PLL_POWERUP | SGTL5000_VCOAMP_POWERUP,
  583. 0);
  584. }
  585. return 0;
  586. }
  587. /*
  588. * Set PCM DAI bit size and sample rate.
  589. * input: params_rate, params_fmt
  590. */
  591. static int sgtl5000_pcm_hw_params(struct snd_pcm_substream *substream,
  592. struct snd_pcm_hw_params *params,
  593. struct snd_soc_dai *dai)
  594. {
  595. struct snd_soc_codec *codec = dai->codec;
  596. struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
  597. int channels = params_channels(params);
  598. int i2s_ctl = 0;
  599. int stereo;
  600. int ret;
  601. /* sysclk should already set */
  602. if (!sgtl5000->sysclk) {
  603. dev_err(codec->dev, "%s: set sysclk first!\n", __func__);
  604. return -EFAULT;
  605. }
  606. if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
  607. stereo = SGTL5000_DAC_STEREO;
  608. else
  609. stereo = SGTL5000_ADC_STEREO;
  610. /* set mono to save power */
  611. snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER, stereo,
  612. channels == 1 ? 0 : stereo);
  613. /* set codec clock base on lrclk */
  614. ret = sgtl5000_set_clock(codec, params_rate(params));
  615. if (ret)
  616. return ret;
  617. /* set i2s data format */
  618. switch (params_format(params)) {
  619. case SNDRV_PCM_FORMAT_S16_LE:
  620. if (sgtl5000->fmt == SND_SOC_DAIFMT_RIGHT_J)
  621. return -EINVAL;
  622. i2s_ctl |= SGTL5000_I2S_DLEN_16 << SGTL5000_I2S_DLEN_SHIFT;
  623. i2s_ctl |= SGTL5000_I2S_SCLKFREQ_32FS <<
  624. SGTL5000_I2S_SCLKFREQ_SHIFT;
  625. break;
  626. case SNDRV_PCM_FORMAT_S20_3LE:
  627. i2s_ctl |= SGTL5000_I2S_DLEN_20 << SGTL5000_I2S_DLEN_SHIFT;
  628. i2s_ctl |= SGTL5000_I2S_SCLKFREQ_64FS <<
  629. SGTL5000_I2S_SCLKFREQ_SHIFT;
  630. break;
  631. case SNDRV_PCM_FORMAT_S24_LE:
  632. i2s_ctl |= SGTL5000_I2S_DLEN_24 << SGTL5000_I2S_DLEN_SHIFT;
  633. i2s_ctl |= SGTL5000_I2S_SCLKFREQ_64FS <<
  634. SGTL5000_I2S_SCLKFREQ_SHIFT;
  635. break;
  636. case SNDRV_PCM_FORMAT_S32_LE:
  637. if (sgtl5000->fmt == SND_SOC_DAIFMT_RIGHT_J)
  638. return -EINVAL;
  639. i2s_ctl |= SGTL5000_I2S_DLEN_32 << SGTL5000_I2S_DLEN_SHIFT;
  640. i2s_ctl |= SGTL5000_I2S_SCLKFREQ_64FS <<
  641. SGTL5000_I2S_SCLKFREQ_SHIFT;
  642. break;
  643. default:
  644. return -EINVAL;
  645. }
  646. snd_soc_update_bits(codec, SGTL5000_CHIP_I2S_CTRL,
  647. SGTL5000_I2S_DLEN_MASK | SGTL5000_I2S_SCLKFREQ_MASK,
  648. i2s_ctl);
  649. return 0;
  650. }
  651. #ifdef CONFIG_REGULATOR
  652. static int ldo_regulator_is_enabled(struct regulator_dev *dev)
  653. {
  654. struct ldo_regulator *ldo = rdev_get_drvdata(dev);
  655. return ldo->enabled;
  656. }
  657. static int ldo_regulator_enable(struct regulator_dev *dev)
  658. {
  659. struct ldo_regulator *ldo = rdev_get_drvdata(dev);
  660. struct snd_soc_codec *codec = (struct snd_soc_codec *)ldo->codec_data;
  661. int reg;
  662. if (ldo_regulator_is_enabled(dev))
  663. return 0;
  664. /* set regulator value firstly */
  665. reg = (1600 - ldo->voltage / 1000) / 50;
  666. reg = clamp(reg, 0x0, 0xf);
  667. /* amend the voltage value, unit: uV */
  668. ldo->voltage = (1600 - reg * 50) * 1000;
  669. /* set voltage to register */
  670. snd_soc_update_bits(codec, SGTL5000_CHIP_LINREG_CTRL,
  671. SGTL5000_LINREG_VDDD_MASK, reg);
  672. snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
  673. SGTL5000_LINEREG_D_POWERUP,
  674. SGTL5000_LINEREG_D_POWERUP);
  675. /* when internal ldo enabled, simple digital power can be disabled */
  676. snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
  677. SGTL5000_LINREG_SIMPLE_POWERUP,
  678. 0);
  679. ldo->enabled = 1;
  680. return 0;
  681. }
  682. static int ldo_regulator_disable(struct regulator_dev *dev)
  683. {
  684. struct ldo_regulator *ldo = rdev_get_drvdata(dev);
  685. struct snd_soc_codec *codec = (struct snd_soc_codec *)ldo->codec_data;
  686. snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
  687. SGTL5000_LINEREG_D_POWERUP,
  688. 0);
  689. /* clear voltage info */
  690. snd_soc_update_bits(codec, SGTL5000_CHIP_LINREG_CTRL,
  691. SGTL5000_LINREG_VDDD_MASK, 0);
  692. ldo->enabled = 0;
  693. return 0;
  694. }
  695. static int ldo_regulator_get_voltage(struct regulator_dev *dev)
  696. {
  697. struct ldo_regulator *ldo = rdev_get_drvdata(dev);
  698. return ldo->voltage;
  699. }
  700. static struct regulator_ops ldo_regulator_ops = {
  701. .is_enabled = ldo_regulator_is_enabled,
  702. .enable = ldo_regulator_enable,
  703. .disable = ldo_regulator_disable,
  704. .get_voltage = ldo_regulator_get_voltage,
  705. };
  706. static int ldo_regulator_register(struct snd_soc_codec *codec,
  707. struct regulator_init_data *init_data,
  708. int voltage)
  709. {
  710. struct ldo_regulator *ldo;
  711. struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
  712. struct regulator_config config = { };
  713. ldo = kzalloc(sizeof(struct ldo_regulator), GFP_KERNEL);
  714. if (!ldo) {
  715. dev_err(codec->dev, "failed to allocate ldo_regulator\n");
  716. return -ENOMEM;
  717. }
  718. ldo->desc.name = kstrdup(dev_name(codec->dev), GFP_KERNEL);
  719. if (!ldo->desc.name) {
  720. kfree(ldo);
  721. dev_err(codec->dev, "failed to allocate decs name memory\n");
  722. return -ENOMEM;
  723. }
  724. ldo->desc.type = REGULATOR_VOLTAGE;
  725. ldo->desc.owner = THIS_MODULE;
  726. ldo->desc.ops = &ldo_regulator_ops;
  727. ldo->desc.n_voltages = 1;
  728. ldo->codec_data = codec;
  729. ldo->voltage = voltage;
  730. config.dev = codec->dev;
  731. config.driver_data = ldo;
  732. config.init_data = init_data;
  733. ldo->dev = regulator_register(&ldo->desc, &config);
  734. if (IS_ERR(ldo->dev)) {
  735. int ret = PTR_ERR(ldo->dev);
  736. dev_err(codec->dev, "failed to register regulator\n");
  737. kfree(ldo->desc.name);
  738. kfree(ldo);
  739. return ret;
  740. }
  741. sgtl5000->ldo = ldo;
  742. return 0;
  743. }
  744. static int ldo_regulator_remove(struct snd_soc_codec *codec)
  745. {
  746. struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
  747. struct ldo_regulator *ldo = sgtl5000->ldo;
  748. if (!ldo)
  749. return 0;
  750. regulator_unregister(ldo->dev);
  751. kfree(ldo->desc.name);
  752. kfree(ldo);
  753. return 0;
  754. }
  755. #else
  756. static int ldo_regulator_register(struct snd_soc_codec *codec,
  757. struct regulator_init_data *init_data,
  758. int voltage)
  759. {
  760. dev_err(codec->dev, "this setup needs regulator support in the kernel\n");
  761. return -EINVAL;
  762. }
  763. static int ldo_regulator_remove(struct snd_soc_codec *codec)
  764. {
  765. return 0;
  766. }
  767. #endif
  768. /*
  769. * set dac bias
  770. * common state changes:
  771. * startup:
  772. * off --> standby --> prepare --> on
  773. * standby --> prepare --> on
  774. *
  775. * stop:
  776. * on --> prepare --> standby
  777. */
  778. static int sgtl5000_set_bias_level(struct snd_soc_codec *codec,
  779. enum snd_soc_bias_level level)
  780. {
  781. int ret;
  782. struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
  783. switch (level) {
  784. case SND_SOC_BIAS_ON:
  785. case SND_SOC_BIAS_PREPARE:
  786. break;
  787. case SND_SOC_BIAS_STANDBY:
  788. if (codec->dapm.bias_level == SND_SOC_BIAS_OFF) {
  789. ret = regulator_bulk_enable(
  790. ARRAY_SIZE(sgtl5000->supplies),
  791. sgtl5000->supplies);
  792. if (ret)
  793. return ret;
  794. udelay(10);
  795. regcache_cache_only(sgtl5000->regmap, false);
  796. ret = regcache_sync(sgtl5000->regmap);
  797. if (ret != 0) {
  798. dev_err(codec->dev,
  799. "Failed to restore cache: %d\n", ret);
  800. regcache_cache_only(sgtl5000->regmap, true);
  801. regulator_bulk_disable(ARRAY_SIZE(sgtl5000->supplies),
  802. sgtl5000->supplies);
  803. return ret;
  804. }
  805. }
  806. break;
  807. case SND_SOC_BIAS_OFF:
  808. regcache_cache_only(sgtl5000->regmap, true);
  809. regulator_bulk_disable(ARRAY_SIZE(sgtl5000->supplies),
  810. sgtl5000->supplies);
  811. break;
  812. }
  813. codec->dapm.bias_level = level;
  814. return 0;
  815. }
  816. #define SGTL5000_FORMATS (SNDRV_PCM_FMTBIT_S16_LE |\
  817. SNDRV_PCM_FMTBIT_S20_3LE |\
  818. SNDRV_PCM_FMTBIT_S24_LE |\
  819. SNDRV_PCM_FMTBIT_S32_LE)
  820. static const struct snd_soc_dai_ops sgtl5000_ops = {
  821. .hw_params = sgtl5000_pcm_hw_params,
  822. .digital_mute = sgtl5000_digital_mute,
  823. .set_fmt = sgtl5000_set_dai_fmt,
  824. .set_sysclk = sgtl5000_set_dai_sysclk,
  825. };
  826. static struct snd_soc_dai_driver sgtl5000_dai = {
  827. .name = "sgtl5000",
  828. .playback = {
  829. .stream_name = "Playback",
  830. .channels_min = 1,
  831. .channels_max = 2,
  832. /*
  833. * only support 8~48K + 96K,
  834. * TODO modify hw_param to support more
  835. */
  836. .rates = SNDRV_PCM_RATE_8000_48000 | SNDRV_PCM_RATE_96000,
  837. .formats = SGTL5000_FORMATS,
  838. },
  839. .capture = {
  840. .stream_name = "Capture",
  841. .channels_min = 1,
  842. .channels_max = 2,
  843. .rates = SNDRV_PCM_RATE_8000_48000 | SNDRV_PCM_RATE_96000,
  844. .formats = SGTL5000_FORMATS,
  845. },
  846. .ops = &sgtl5000_ops,
  847. .symmetric_rates = 1,
  848. };
  849. static bool sgtl5000_volatile(struct device *dev, unsigned int reg)
  850. {
  851. switch (reg) {
  852. case SGTL5000_CHIP_ID:
  853. case SGTL5000_CHIP_ADCDAC_CTRL:
  854. case SGTL5000_CHIP_ANA_STATUS:
  855. return true;
  856. }
  857. return false;
  858. }
  859. static bool sgtl5000_readable(struct device *dev, unsigned int reg)
  860. {
  861. switch (reg) {
  862. case SGTL5000_CHIP_ID:
  863. case SGTL5000_CHIP_DIG_POWER:
  864. case SGTL5000_CHIP_CLK_CTRL:
  865. case SGTL5000_CHIP_I2S_CTRL:
  866. case SGTL5000_CHIP_SSS_CTRL:
  867. case SGTL5000_CHIP_ADCDAC_CTRL:
  868. case SGTL5000_CHIP_DAC_VOL:
  869. case SGTL5000_CHIP_PAD_STRENGTH:
  870. case SGTL5000_CHIP_ANA_ADC_CTRL:
  871. case SGTL5000_CHIP_ANA_HP_CTRL:
  872. case SGTL5000_CHIP_ANA_CTRL:
  873. case SGTL5000_CHIP_LINREG_CTRL:
  874. case SGTL5000_CHIP_REF_CTRL:
  875. case SGTL5000_CHIP_MIC_CTRL:
  876. case SGTL5000_CHIP_LINE_OUT_CTRL:
  877. case SGTL5000_CHIP_LINE_OUT_VOL:
  878. case SGTL5000_CHIP_ANA_POWER:
  879. case SGTL5000_CHIP_PLL_CTRL:
  880. case SGTL5000_CHIP_CLK_TOP_CTRL:
  881. case SGTL5000_CHIP_ANA_STATUS:
  882. case SGTL5000_CHIP_SHORT_CTRL:
  883. case SGTL5000_CHIP_ANA_TEST2:
  884. case SGTL5000_DAP_CTRL:
  885. case SGTL5000_DAP_PEQ:
  886. case SGTL5000_DAP_BASS_ENHANCE:
  887. case SGTL5000_DAP_BASS_ENHANCE_CTRL:
  888. case SGTL5000_DAP_AUDIO_EQ:
  889. case SGTL5000_DAP_SURROUND:
  890. case SGTL5000_DAP_FLT_COEF_ACCESS:
  891. case SGTL5000_DAP_COEF_WR_B0_MSB:
  892. case SGTL5000_DAP_COEF_WR_B0_LSB:
  893. case SGTL5000_DAP_EQ_BASS_BAND0:
  894. case SGTL5000_DAP_EQ_BASS_BAND1:
  895. case SGTL5000_DAP_EQ_BASS_BAND2:
  896. case SGTL5000_DAP_EQ_BASS_BAND3:
  897. case SGTL5000_DAP_EQ_BASS_BAND4:
  898. case SGTL5000_DAP_MAIN_CHAN:
  899. case SGTL5000_DAP_MIX_CHAN:
  900. case SGTL5000_DAP_AVC_CTRL:
  901. case SGTL5000_DAP_AVC_THRESHOLD:
  902. case SGTL5000_DAP_AVC_ATTACK:
  903. case SGTL5000_DAP_AVC_DECAY:
  904. case SGTL5000_DAP_COEF_WR_B1_MSB:
  905. case SGTL5000_DAP_COEF_WR_B1_LSB:
  906. case SGTL5000_DAP_COEF_WR_B2_MSB:
  907. case SGTL5000_DAP_COEF_WR_B2_LSB:
  908. case SGTL5000_DAP_COEF_WR_A1_MSB:
  909. case SGTL5000_DAP_COEF_WR_A1_LSB:
  910. case SGTL5000_DAP_COEF_WR_A2_MSB:
  911. case SGTL5000_DAP_COEF_WR_A2_LSB:
  912. return true;
  913. default:
  914. return false;
  915. }
  916. }
  917. #ifdef CONFIG_SUSPEND
  918. static int sgtl5000_suspend(struct snd_soc_codec *codec)
  919. {
  920. sgtl5000_set_bias_level(codec, SND_SOC_BIAS_OFF);
  921. return 0;
  922. }
  923. /*
  924. * restore all sgtl5000 registers,
  925. * since a big hole between dap and regular registers,
  926. * we will restore them respectively.
  927. */
  928. static int sgtl5000_restore_regs(struct snd_soc_codec *codec)
  929. {
  930. u16 *cache = codec->reg_cache;
  931. u16 reg;
  932. /* restore regular registers */
  933. for (reg = 0; reg <= SGTL5000_CHIP_SHORT_CTRL; reg += 2) {
  934. /* These regs should restore in particular order */
  935. if (reg == SGTL5000_CHIP_ANA_POWER ||
  936. reg == SGTL5000_CHIP_CLK_CTRL ||
  937. reg == SGTL5000_CHIP_LINREG_CTRL ||
  938. reg == SGTL5000_CHIP_LINE_OUT_CTRL ||
  939. reg == SGTL5000_CHIP_REF_CTRL)
  940. continue;
  941. snd_soc_write(codec, reg, cache[reg]);
  942. }
  943. /* restore dap registers */
  944. for (reg = SGTL5000_DAP_REG_OFFSET; reg < SGTL5000_MAX_REG_OFFSET; reg += 2)
  945. snd_soc_write(codec, reg, cache[reg]);
  946. /*
  947. * restore these regs according to the power setting sequence in
  948. * sgtl5000_set_power_regs() and clock setting sequence in
  949. * sgtl5000_set_clock().
  950. *
  951. * The order of restore is:
  952. * 1. SGTL5000_CHIP_CLK_CTRL MCLK_FREQ bits (1:0) should be restore after
  953. * SGTL5000_CHIP_ANA_POWER PLL bits set
  954. * 2. SGTL5000_CHIP_LINREG_CTRL should be set before
  955. * SGTL5000_CHIP_ANA_POWER LINREG_D restored
  956. * 3. SGTL5000_CHIP_REF_CTRL controls Analog Ground Voltage,
  957. * prefer to resotre it after SGTL5000_CHIP_ANA_POWER restored
  958. */
  959. snd_soc_write(codec, SGTL5000_CHIP_LINREG_CTRL,
  960. cache[SGTL5000_CHIP_LINREG_CTRL]);
  961. snd_soc_write(codec, SGTL5000_CHIP_ANA_POWER,
  962. cache[SGTL5000_CHIP_ANA_POWER]);
  963. snd_soc_write(codec, SGTL5000_CHIP_CLK_CTRL,
  964. cache[SGTL5000_CHIP_CLK_CTRL]);
  965. snd_soc_write(codec, SGTL5000_CHIP_REF_CTRL,
  966. cache[SGTL5000_CHIP_REF_CTRL]);
  967. snd_soc_write(codec, SGTL5000_CHIP_LINE_OUT_CTRL,
  968. cache[SGTL5000_CHIP_LINE_OUT_CTRL]);
  969. return 0;
  970. }
  971. static int sgtl5000_resume(struct snd_soc_codec *codec)
  972. {
  973. /* Bring the codec back up to standby to enable regulators */
  974. sgtl5000_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
  975. /* Restore registers by cached in memory */
  976. sgtl5000_restore_regs(codec);
  977. return 0;
  978. }
  979. #else
  980. #define sgtl5000_suspend NULL
  981. #define sgtl5000_resume NULL
  982. #endif /* CONFIG_SUSPEND */
  983. /*
  984. * sgtl5000 has 3 internal power supplies:
  985. * 1. VAG, normally set to vdda/2
  986. * 2. chargepump, set to different value
  987. * according to voltage of vdda and vddio
  988. * 3. line out VAG, normally set to vddio/2
  989. *
  990. * and should be set according to:
  991. * 1. vddd provided by external or not
  992. * 2. vdda and vddio voltage value. > 3.1v or not
  993. * 3. chip revision >=0x11 or not. If >=0x11, not use external vddd.
  994. */
  995. static int sgtl5000_set_power_regs(struct snd_soc_codec *codec)
  996. {
  997. int vddd;
  998. int vdda;
  999. int vddio;
  1000. u16 ana_pwr;
  1001. u16 lreg_ctrl;
  1002. int vag;
  1003. struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
  1004. vdda = regulator_get_voltage(sgtl5000->supplies[VDDA].consumer);
  1005. vddio = regulator_get_voltage(sgtl5000->supplies[VDDIO].consumer);
  1006. vddd = regulator_get_voltage(sgtl5000->supplies[VDDD].consumer);
  1007. vdda = vdda / 1000;
  1008. vddio = vddio / 1000;
  1009. vddd = vddd / 1000;
  1010. if (vdda <= 0 || vddio <= 0 || vddd < 0) {
  1011. dev_err(codec->dev, "regulator voltage not set correctly\n");
  1012. return -EINVAL;
  1013. }
  1014. /* according to datasheet, maximum voltage of supplies */
  1015. if (vdda > 3600 || vddio > 3600 || vddd > 1980) {
  1016. dev_err(codec->dev,
  1017. "exceed max voltage vdda %dmV vddio %dmV vddd %dmV\n",
  1018. vdda, vddio, vddd);
  1019. return -EINVAL;
  1020. }
  1021. /* reset value */
  1022. ana_pwr = snd_soc_read(codec, SGTL5000_CHIP_ANA_POWER);
  1023. ana_pwr |= SGTL5000_DAC_STEREO |
  1024. SGTL5000_ADC_STEREO |
  1025. SGTL5000_REFTOP_POWERUP;
  1026. lreg_ctrl = snd_soc_read(codec, SGTL5000_CHIP_LINREG_CTRL);
  1027. if (vddio < 3100 && vdda < 3100) {
  1028. /* enable internal oscillator used for charge pump */
  1029. snd_soc_update_bits(codec, SGTL5000_CHIP_CLK_TOP_CTRL,
  1030. SGTL5000_INT_OSC_EN,
  1031. SGTL5000_INT_OSC_EN);
  1032. /* Enable VDDC charge pump */
  1033. ana_pwr |= SGTL5000_VDDC_CHRGPMP_POWERUP;
  1034. } else if (vddio >= 3100 && vdda >= 3100) {
  1035. /*
  1036. * if vddio and vddd > 3.1v,
  1037. * charge pump should be clean before set ana_pwr
  1038. */
  1039. snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
  1040. SGTL5000_VDDC_CHRGPMP_POWERUP, 0);
  1041. /* VDDC use VDDIO rail */
  1042. lreg_ctrl |= SGTL5000_VDDC_ASSN_OVRD;
  1043. lreg_ctrl |= SGTL5000_VDDC_MAN_ASSN_VDDIO <<
  1044. SGTL5000_VDDC_MAN_ASSN_SHIFT;
  1045. }
  1046. snd_soc_write(codec, SGTL5000_CHIP_LINREG_CTRL, lreg_ctrl);
  1047. snd_soc_write(codec, SGTL5000_CHIP_ANA_POWER, ana_pwr);
  1048. /* set voltage to register */
  1049. snd_soc_update_bits(codec, SGTL5000_CHIP_LINREG_CTRL,
  1050. SGTL5000_LINREG_VDDD_MASK, 0x8);
  1051. /*
  1052. * if vddd linear reg has been enabled,
  1053. * simple digital supply should be clear to get
  1054. * proper VDDD voltage.
  1055. */
  1056. if (ana_pwr & SGTL5000_LINEREG_D_POWERUP)
  1057. snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
  1058. SGTL5000_LINREG_SIMPLE_POWERUP,
  1059. 0);
  1060. else
  1061. snd_soc_update_bits(codec, SGTL5000_CHIP_ANA_POWER,
  1062. SGTL5000_LINREG_SIMPLE_POWERUP |
  1063. SGTL5000_STARTUP_POWERUP,
  1064. 0);
  1065. /*
  1066. * set ADC/DAC VAG to vdda / 2,
  1067. * should stay in range (0.8v, 1.575v)
  1068. */
  1069. vag = vdda / 2;
  1070. if (vag <= SGTL5000_ANA_GND_BASE)
  1071. vag = 0;
  1072. else if (vag >= SGTL5000_ANA_GND_BASE + SGTL5000_ANA_GND_STP *
  1073. (SGTL5000_ANA_GND_MASK >> SGTL5000_ANA_GND_SHIFT))
  1074. vag = SGTL5000_ANA_GND_MASK >> SGTL5000_ANA_GND_SHIFT;
  1075. else
  1076. vag = (vag - SGTL5000_ANA_GND_BASE) / SGTL5000_ANA_GND_STP;
  1077. snd_soc_update_bits(codec, SGTL5000_CHIP_REF_CTRL,
  1078. SGTL5000_ANA_GND_MASK, vag << SGTL5000_ANA_GND_SHIFT);
  1079. /* set line out VAG to vddio / 2, in range (0.8v, 1.675v) */
  1080. vag = vddio / 2;
  1081. if (vag <= SGTL5000_LINE_OUT_GND_BASE)
  1082. vag = 0;
  1083. else if (vag >= SGTL5000_LINE_OUT_GND_BASE +
  1084. SGTL5000_LINE_OUT_GND_STP * SGTL5000_LINE_OUT_GND_MAX)
  1085. vag = SGTL5000_LINE_OUT_GND_MAX;
  1086. else
  1087. vag = (vag - SGTL5000_LINE_OUT_GND_BASE) /
  1088. SGTL5000_LINE_OUT_GND_STP;
  1089. snd_soc_update_bits(codec, SGTL5000_CHIP_LINE_OUT_CTRL,
  1090. SGTL5000_LINE_OUT_CURRENT_MASK |
  1091. SGTL5000_LINE_OUT_GND_MASK,
  1092. vag << SGTL5000_LINE_OUT_GND_SHIFT |
  1093. SGTL5000_LINE_OUT_CURRENT_360u <<
  1094. SGTL5000_LINE_OUT_CURRENT_SHIFT);
  1095. return 0;
  1096. }
  1097. static int sgtl5000_replace_vddd_with_ldo(struct snd_soc_codec *codec)
  1098. {
  1099. struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
  1100. int ret;
  1101. /* set internal ldo to 1.2v */
  1102. ret = ldo_regulator_register(codec, &ldo_init_data, LDO_VOLTAGE);
  1103. if (ret) {
  1104. dev_err(codec->dev,
  1105. "Failed to register vddd internal supplies: %d\n", ret);
  1106. return ret;
  1107. }
  1108. sgtl5000->supplies[VDDD].supply = LDO_CONSUMER_NAME;
  1109. ret = regulator_bulk_get(codec->dev, ARRAY_SIZE(sgtl5000->supplies),
  1110. sgtl5000->supplies);
  1111. if (ret) {
  1112. ldo_regulator_remove(codec);
  1113. dev_err(codec->dev, "Failed to request supplies: %d\n", ret);
  1114. return ret;
  1115. }
  1116. dev_info(codec->dev, "Using internal LDO instead of VDDD\n");
  1117. return 0;
  1118. }
  1119. static int sgtl5000_enable_regulators(struct snd_soc_codec *codec)
  1120. {
  1121. int reg;
  1122. int ret;
  1123. int rev;
  1124. int i;
  1125. int external_vddd = 0;
  1126. struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
  1127. for (i = 0; i < ARRAY_SIZE(sgtl5000->supplies); i++)
  1128. sgtl5000->supplies[i].supply = supply_names[i];
  1129. ret = regulator_bulk_get(codec->dev, ARRAY_SIZE(sgtl5000->supplies),
  1130. sgtl5000->supplies);
  1131. if (!ret)
  1132. external_vddd = 1;
  1133. else {
  1134. ret = sgtl5000_replace_vddd_with_ldo(codec);
  1135. if (ret)
  1136. return ret;
  1137. }
  1138. ret = regulator_bulk_enable(ARRAY_SIZE(sgtl5000->supplies),
  1139. sgtl5000->supplies);
  1140. if (ret)
  1141. goto err_regulator_free;
  1142. /* wait for all power rails bring up */
  1143. udelay(10);
  1144. /*
  1145. * workaround for revision 0x11 and later,
  1146. * roll back to use internal LDO
  1147. */
  1148. ret = regmap_read(sgtl5000->regmap, SGTL5000_CHIP_ID, &reg);
  1149. if (ret)
  1150. goto err_regulator_disable;
  1151. rev = (reg & SGTL5000_REVID_MASK) >> SGTL5000_REVID_SHIFT;
  1152. if (external_vddd && rev >= 0x11) {
  1153. /* disable all regulator first */
  1154. regulator_bulk_disable(ARRAY_SIZE(sgtl5000->supplies),
  1155. sgtl5000->supplies);
  1156. /* free VDDD regulator */
  1157. regulator_bulk_free(ARRAY_SIZE(sgtl5000->supplies),
  1158. sgtl5000->supplies);
  1159. ret = sgtl5000_replace_vddd_with_ldo(codec);
  1160. if (ret)
  1161. return ret;
  1162. ret = regulator_bulk_enable(ARRAY_SIZE(sgtl5000->supplies),
  1163. sgtl5000->supplies);
  1164. if (ret)
  1165. goto err_regulator_free;
  1166. /* wait for all power rails bring up */
  1167. udelay(10);
  1168. }
  1169. return 0;
  1170. err_regulator_disable:
  1171. regulator_bulk_disable(ARRAY_SIZE(sgtl5000->supplies),
  1172. sgtl5000->supplies);
  1173. err_regulator_free:
  1174. regulator_bulk_free(ARRAY_SIZE(sgtl5000->supplies),
  1175. sgtl5000->supplies);
  1176. if (external_vddd)
  1177. ldo_regulator_remove(codec);
  1178. return ret;
  1179. }
  1180. static int sgtl5000_probe(struct snd_soc_codec *codec)
  1181. {
  1182. int ret;
  1183. struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
  1184. /* setup i2c data ops */
  1185. codec->control_data = sgtl5000->regmap;
  1186. ret = snd_soc_codec_set_cache_io(codec, 16, 16, SND_SOC_REGMAP);
  1187. if (ret < 0) {
  1188. dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
  1189. return ret;
  1190. }
  1191. ret = sgtl5000_enable_regulators(codec);
  1192. if (ret)
  1193. return ret;
  1194. /* power up sgtl5000 */
  1195. ret = sgtl5000_set_power_regs(codec);
  1196. if (ret)
  1197. goto err;
  1198. /* enable small pop, introduce 400ms delay in turning off */
  1199. snd_soc_update_bits(codec, SGTL5000_CHIP_REF_CTRL,
  1200. SGTL5000_SMALL_POP,
  1201. SGTL5000_SMALL_POP);
  1202. /* disable short cut detector */
  1203. snd_soc_write(codec, SGTL5000_CHIP_SHORT_CTRL, 0);
  1204. /*
  1205. * set i2s as default input of sound switch
  1206. * TODO: add sound switch to control and dapm widge.
  1207. */
  1208. snd_soc_write(codec, SGTL5000_CHIP_SSS_CTRL,
  1209. SGTL5000_DAC_SEL_I2S_IN << SGTL5000_DAC_SEL_SHIFT);
  1210. snd_soc_write(codec, SGTL5000_CHIP_DIG_POWER,
  1211. SGTL5000_ADC_EN | SGTL5000_DAC_EN);
  1212. /* enable dac volume ramp by default */
  1213. snd_soc_write(codec, SGTL5000_CHIP_ADCDAC_CTRL,
  1214. SGTL5000_DAC_VOL_RAMP_EN |
  1215. SGTL5000_DAC_MUTE_RIGHT |
  1216. SGTL5000_DAC_MUTE_LEFT);
  1217. snd_soc_write(codec, SGTL5000_CHIP_PAD_STRENGTH, 0x015f);
  1218. snd_soc_write(codec, SGTL5000_CHIP_ANA_CTRL,
  1219. SGTL5000_HP_ZCD_EN |
  1220. SGTL5000_ADC_ZCD_EN);
  1221. snd_soc_write(codec, SGTL5000_CHIP_MIC_CTRL, 2);
  1222. /*
  1223. * disable DAP
  1224. * TODO:
  1225. * Enable DAP in kcontrol and dapm.
  1226. */
  1227. snd_soc_write(codec, SGTL5000_DAP_CTRL, 0);
  1228. /* leading to standby state */
  1229. ret = sgtl5000_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
  1230. if (ret)
  1231. goto err;
  1232. return 0;
  1233. err:
  1234. regulator_bulk_disable(ARRAY_SIZE(sgtl5000->supplies),
  1235. sgtl5000->supplies);
  1236. regulator_bulk_free(ARRAY_SIZE(sgtl5000->supplies),
  1237. sgtl5000->supplies);
  1238. ldo_regulator_remove(codec);
  1239. return ret;
  1240. }
  1241. static int sgtl5000_remove(struct snd_soc_codec *codec)
  1242. {
  1243. struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
  1244. sgtl5000_set_bias_level(codec, SND_SOC_BIAS_OFF);
  1245. regulator_bulk_disable(ARRAY_SIZE(sgtl5000->supplies),
  1246. sgtl5000->supplies);
  1247. regulator_bulk_free(ARRAY_SIZE(sgtl5000->supplies),
  1248. sgtl5000->supplies);
  1249. ldo_regulator_remove(codec);
  1250. return 0;
  1251. }
  1252. static struct snd_soc_codec_driver sgtl5000_driver = {
  1253. .probe = sgtl5000_probe,
  1254. .remove = sgtl5000_remove,
  1255. .suspend = sgtl5000_suspend,
  1256. .resume = sgtl5000_resume,
  1257. .set_bias_level = sgtl5000_set_bias_level,
  1258. .controls = sgtl5000_snd_controls,
  1259. .num_controls = ARRAY_SIZE(sgtl5000_snd_controls),
  1260. .dapm_widgets = sgtl5000_dapm_widgets,
  1261. .num_dapm_widgets = ARRAY_SIZE(sgtl5000_dapm_widgets),
  1262. .dapm_routes = sgtl5000_dapm_routes,
  1263. .num_dapm_routes = ARRAY_SIZE(sgtl5000_dapm_routes),
  1264. };
  1265. static const struct regmap_config sgtl5000_regmap = {
  1266. .reg_bits = 16,
  1267. .val_bits = 16,
  1268. .reg_stride = 2,
  1269. .max_register = SGTL5000_MAX_REG_OFFSET,
  1270. .volatile_reg = sgtl5000_volatile,
  1271. .readable_reg = sgtl5000_readable,
  1272. .cache_type = REGCACHE_RBTREE,
  1273. .reg_defaults = sgtl5000_reg_defaults,
  1274. .num_reg_defaults = ARRAY_SIZE(sgtl5000_reg_defaults),
  1275. };
  1276. /*
  1277. * Write all the default values from sgtl5000_reg_defaults[] array into the
  1278. * sgtl5000 registers, to make sure we always start with the sane registers
  1279. * values as stated in the datasheet.
  1280. *
  1281. * Since sgtl5000 does not have a reset line, nor a reset command in software,
  1282. * we follow this approach to guarantee we always start from the default values
  1283. * and avoid problems like, not being able to probe after an audio playback
  1284. * followed by a system reset or a 'reboot' command in Linux
  1285. */
  1286. static int sgtl5000_fill_defaults(struct sgtl5000_priv *sgtl5000)
  1287. {
  1288. int i, ret, val, index;
  1289. for (i = 0; i < ARRAY_SIZE(sgtl5000_reg_defaults); i++) {
  1290. val = sgtl5000_reg_defaults[i].def;
  1291. index = sgtl5000_reg_defaults[i].reg;
  1292. ret = regmap_write(sgtl5000->regmap, index, val);
  1293. if (ret)
  1294. return ret;
  1295. }
  1296. return 0;
  1297. }
  1298. static int sgtl5000_i2c_probe(struct i2c_client *client,
  1299. const struct i2c_device_id *id)
  1300. {
  1301. struct sgtl5000_priv *sgtl5000;
  1302. int ret, reg, rev;
  1303. sgtl5000 = devm_kzalloc(&client->dev, sizeof(struct sgtl5000_priv),
  1304. GFP_KERNEL);
  1305. if (!sgtl5000)
  1306. return -ENOMEM;
  1307. sgtl5000->regmap = devm_regmap_init_i2c(client, &sgtl5000_regmap);
  1308. if (IS_ERR(sgtl5000->regmap)) {
  1309. ret = PTR_ERR(sgtl5000->regmap);
  1310. dev_err(&client->dev, "Failed to allocate regmap: %d\n", ret);
  1311. return ret;
  1312. }
  1313. sgtl5000->mclk = devm_clk_get(&client->dev, NULL);
  1314. if (IS_ERR(sgtl5000->mclk)) {
  1315. ret = PTR_ERR(sgtl5000->mclk);
  1316. dev_err(&client->dev, "Failed to get mclock: %d\n", ret);
  1317. /* Defer the probe to see if the clk will be provided later */
  1318. if (ret == -ENOENT)
  1319. return -EPROBE_DEFER;
  1320. return ret;
  1321. }
  1322. ret = clk_prepare_enable(sgtl5000->mclk);
  1323. if (ret)
  1324. return ret;
  1325. /* read chip information */
  1326. ret = regmap_read(sgtl5000->regmap, SGTL5000_CHIP_ID, &reg);
  1327. if (ret)
  1328. goto disable_clk;
  1329. if (((reg & SGTL5000_PARTID_MASK) >> SGTL5000_PARTID_SHIFT) !=
  1330. SGTL5000_PARTID_PART_ID) {
  1331. dev_err(&client->dev,
  1332. "Device with ID register %x is not a sgtl5000\n", reg);
  1333. ret = -ENODEV;
  1334. goto disable_clk;
  1335. }
  1336. rev = (reg & SGTL5000_REVID_MASK) >> SGTL5000_REVID_SHIFT;
  1337. dev_info(&client->dev, "sgtl5000 revision 0x%x\n", rev);
  1338. i2c_set_clientdata(client, sgtl5000);
  1339. /* Ensure sgtl5000 will start with sane register values */
  1340. ret = sgtl5000_fill_defaults(sgtl5000);
  1341. if (ret)
  1342. goto disable_clk;
  1343. ret = snd_soc_register_codec(&client->dev,
  1344. &sgtl5000_driver, &sgtl5000_dai, 1);
  1345. if (ret)
  1346. goto disable_clk;
  1347. return 0;
  1348. disable_clk:
  1349. clk_disable_unprepare(sgtl5000->mclk);
  1350. return ret;
  1351. }
  1352. static int sgtl5000_i2c_remove(struct i2c_client *client)
  1353. {
  1354. struct sgtl5000_priv *sgtl5000 = i2c_get_clientdata(client);
  1355. snd_soc_unregister_codec(&client->dev);
  1356. clk_disable_unprepare(sgtl5000->mclk);
  1357. return 0;
  1358. }
  1359. static const struct i2c_device_id sgtl5000_id[] = {
  1360. {"sgtl5000", 0},
  1361. {},
  1362. };
  1363. MODULE_DEVICE_TABLE(i2c, sgtl5000_id);
  1364. static const struct of_device_id sgtl5000_dt_ids[] = {
  1365. { .compatible = "fsl,sgtl5000", },
  1366. { /* sentinel */ }
  1367. };
  1368. MODULE_DEVICE_TABLE(of, sgtl5000_dt_ids);
  1369. static struct i2c_driver sgtl5000_i2c_driver = {
  1370. .driver = {
  1371. .name = "sgtl5000",
  1372. .owner = THIS_MODULE,
  1373. .of_match_table = sgtl5000_dt_ids,
  1374. },
  1375. .probe = sgtl5000_i2c_probe,
  1376. .remove = sgtl5000_i2c_remove,
  1377. .id_table = sgtl5000_id,
  1378. };
  1379. module_i2c_driver(sgtl5000_i2c_driver);
  1380. MODULE_DESCRIPTION("Freescale SGTL5000 ALSA SoC Codec Driver");
  1381. MODULE_AUTHOR("Zeng Zhaoming <zengzm.kernel@gmail.com>");
  1382. MODULE_LICENSE("GPL");