patch_cs8409.h 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. /*
  3. * HD audio interface patch for Cirrus Logic CS8409 HDA bridge chip
  4. *
  5. * Copyright (C) 2021 Cirrus Logic, Inc. and
  6. * Cirrus Logic International Semiconductor Ltd.
  7. */
  8. #ifndef __CS8409_PATCH_H
  9. #define __CS8409_PATCH_H
  10. #include <linux/pci.h>
  11. #include <sound/tlv.h>
  12. #include <linux/workqueue.h>
  13. #include <sound/cs42l42.h>
  14. #include <sound/hda_codec.h>
  15. #include "hda_local.h"
  16. #include "hda_auto_parser.h"
  17. #include "hda_jack.h"
  18. #include "hda_generic.h"
  19. /* CS8409 Specific Definitions */
  20. enum cs8409_pins {
  21. CS8409_PIN_ROOT,
  22. CS8409_PIN_AFG,
  23. CS8409_PIN_ASP1_OUT_A,
  24. CS8409_PIN_ASP1_OUT_B,
  25. CS8409_PIN_ASP1_OUT_C,
  26. CS8409_PIN_ASP1_OUT_D,
  27. CS8409_PIN_ASP1_OUT_E,
  28. CS8409_PIN_ASP1_OUT_F,
  29. CS8409_PIN_ASP1_OUT_G,
  30. CS8409_PIN_ASP1_OUT_H,
  31. CS8409_PIN_ASP2_OUT_A,
  32. CS8409_PIN_ASP2_OUT_B,
  33. CS8409_PIN_ASP2_OUT_C,
  34. CS8409_PIN_ASP2_OUT_D,
  35. CS8409_PIN_ASP2_OUT_E,
  36. CS8409_PIN_ASP2_OUT_F,
  37. CS8409_PIN_ASP2_OUT_G,
  38. CS8409_PIN_ASP2_OUT_H,
  39. CS8409_PIN_ASP1_IN_A,
  40. CS8409_PIN_ASP1_IN_B,
  41. CS8409_PIN_ASP1_IN_C,
  42. CS8409_PIN_ASP1_IN_D,
  43. CS8409_PIN_ASP1_IN_E,
  44. CS8409_PIN_ASP1_IN_F,
  45. CS8409_PIN_ASP1_IN_G,
  46. CS8409_PIN_ASP1_IN_H,
  47. CS8409_PIN_ASP2_IN_A,
  48. CS8409_PIN_ASP2_IN_B,
  49. CS8409_PIN_ASP2_IN_C,
  50. CS8409_PIN_ASP2_IN_D,
  51. CS8409_PIN_ASP2_IN_E,
  52. CS8409_PIN_ASP2_IN_F,
  53. CS8409_PIN_ASP2_IN_G,
  54. CS8409_PIN_ASP2_IN_H,
  55. CS8409_PIN_DMIC1,
  56. CS8409_PIN_DMIC2,
  57. CS8409_PIN_ASP1_TRANSMITTER_A,
  58. CS8409_PIN_ASP1_TRANSMITTER_B,
  59. CS8409_PIN_ASP1_TRANSMITTER_C,
  60. CS8409_PIN_ASP1_TRANSMITTER_D,
  61. CS8409_PIN_ASP1_TRANSMITTER_E,
  62. CS8409_PIN_ASP1_TRANSMITTER_F,
  63. CS8409_PIN_ASP1_TRANSMITTER_G,
  64. CS8409_PIN_ASP1_TRANSMITTER_H,
  65. CS8409_PIN_ASP2_TRANSMITTER_A,
  66. CS8409_PIN_ASP2_TRANSMITTER_B,
  67. CS8409_PIN_ASP2_TRANSMITTER_C,
  68. CS8409_PIN_ASP2_TRANSMITTER_D,
  69. CS8409_PIN_ASP2_TRANSMITTER_E,
  70. CS8409_PIN_ASP2_TRANSMITTER_F,
  71. CS8409_PIN_ASP2_TRANSMITTER_G,
  72. CS8409_PIN_ASP2_TRANSMITTER_H,
  73. CS8409_PIN_ASP1_RECEIVER_A,
  74. CS8409_PIN_ASP1_RECEIVER_B,
  75. CS8409_PIN_ASP1_RECEIVER_C,
  76. CS8409_PIN_ASP1_RECEIVER_D,
  77. CS8409_PIN_ASP1_RECEIVER_E,
  78. CS8409_PIN_ASP1_RECEIVER_F,
  79. CS8409_PIN_ASP1_RECEIVER_G,
  80. CS8409_PIN_ASP1_RECEIVER_H,
  81. CS8409_PIN_ASP2_RECEIVER_A,
  82. CS8409_PIN_ASP2_RECEIVER_B,
  83. CS8409_PIN_ASP2_RECEIVER_C,
  84. CS8409_PIN_ASP2_RECEIVER_D,
  85. CS8409_PIN_ASP2_RECEIVER_E,
  86. CS8409_PIN_ASP2_RECEIVER_F,
  87. CS8409_PIN_ASP2_RECEIVER_G,
  88. CS8409_PIN_ASP2_RECEIVER_H,
  89. CS8409_PIN_DMIC1_IN,
  90. CS8409_PIN_DMIC2_IN,
  91. CS8409_PIN_BEEP_GEN,
  92. CS8409_PIN_VENDOR_WIDGET
  93. };
  94. enum cs8409_coefficient_index_registers {
  95. CS8409_DEV_CFG1,
  96. CS8409_DEV_CFG2,
  97. CS8409_DEV_CFG3,
  98. CS8409_ASP1_CLK_CTRL1,
  99. CS8409_ASP1_CLK_CTRL2,
  100. CS8409_ASP1_CLK_CTRL3,
  101. CS8409_ASP2_CLK_CTRL1,
  102. CS8409_ASP2_CLK_CTRL2,
  103. CS8409_ASP2_CLK_CTRL3,
  104. CS8409_DMIC_CFG,
  105. CS8409_BEEP_CFG,
  106. ASP1_RX_NULL_INS_RMV,
  107. ASP1_Rx_RATE1,
  108. ASP1_Rx_RATE2,
  109. ASP1_Tx_NULL_INS_RMV,
  110. ASP1_Tx_RATE1,
  111. ASP1_Tx_RATE2,
  112. ASP2_Rx_NULL_INS_RMV,
  113. ASP2_Rx_RATE1,
  114. ASP2_Rx_RATE2,
  115. ASP2_Tx_NULL_INS_RMV,
  116. ASP2_Tx_RATE1,
  117. ASP2_Tx_RATE2,
  118. ASP1_SYNC_CTRL,
  119. ASP2_SYNC_CTRL,
  120. ASP1_A_TX_CTRL1,
  121. ASP1_A_TX_CTRL2,
  122. ASP1_B_TX_CTRL1,
  123. ASP1_B_TX_CTRL2,
  124. ASP1_C_TX_CTRL1,
  125. ASP1_C_TX_CTRL2,
  126. ASP1_D_TX_CTRL1,
  127. ASP1_D_TX_CTRL2,
  128. ASP1_E_TX_CTRL1,
  129. ASP1_E_TX_CTRL2,
  130. ASP1_F_TX_CTRL1,
  131. ASP1_F_TX_CTRL2,
  132. ASP1_G_TX_CTRL1,
  133. ASP1_G_TX_CTRL2,
  134. ASP1_H_TX_CTRL1,
  135. ASP1_H_TX_CTRL2,
  136. ASP2_A_TX_CTRL1,
  137. ASP2_A_TX_CTRL2,
  138. ASP2_B_TX_CTRL1,
  139. ASP2_B_TX_CTRL2,
  140. ASP2_C_TX_CTRL1,
  141. ASP2_C_TX_CTRL2,
  142. ASP2_D_TX_CTRL1,
  143. ASP2_D_TX_CTRL2,
  144. ASP2_E_TX_CTRL1,
  145. ASP2_E_TX_CTRL2,
  146. ASP2_F_TX_CTRL1,
  147. ASP2_F_TX_CTRL2,
  148. ASP2_G_TX_CTRL1,
  149. ASP2_G_TX_CTRL2,
  150. ASP2_H_TX_CTRL1,
  151. ASP2_H_TX_CTRL2,
  152. ASP1_A_RX_CTRL1,
  153. ASP1_A_RX_CTRL2,
  154. ASP1_B_RX_CTRL1,
  155. ASP1_B_RX_CTRL2,
  156. ASP1_C_RX_CTRL1,
  157. ASP1_C_RX_CTRL2,
  158. ASP1_D_RX_CTRL1,
  159. ASP1_D_RX_CTRL2,
  160. ASP1_E_RX_CTRL1,
  161. ASP1_E_RX_CTRL2,
  162. ASP1_F_RX_CTRL1,
  163. ASP1_F_RX_CTRL2,
  164. ASP1_G_RX_CTRL1,
  165. ASP1_G_RX_CTRL2,
  166. ASP1_H_RX_CTRL1,
  167. ASP1_H_RX_CTRL2,
  168. ASP2_A_RX_CTRL1,
  169. ASP2_A_RX_CTRL2,
  170. ASP2_B_RX_CTRL1,
  171. ASP2_B_RX_CTRL2,
  172. ASP2_C_RX_CTRL1,
  173. ASP2_C_RX_CTRL2,
  174. ASP2_D_RX_CTRL1,
  175. ASP2_D_RX_CTRL2,
  176. ASP2_E_RX_CTRL1,
  177. ASP2_E_RX_CTRL2,
  178. ASP2_F_RX_CTRL1,
  179. ASP2_F_RX_CTRL2,
  180. ASP2_G_RX_CTRL1,
  181. ASP2_G_RX_CTRL2,
  182. ASP2_H_RX_CTRL1,
  183. ASP2_H_RX_CTRL2,
  184. CS8409_I2C_ADDR,
  185. CS8409_I2C_DATA,
  186. CS8409_I2C_CTRL,
  187. CS8409_I2C_STS,
  188. CS8409_I2C_QWRITE,
  189. CS8409_I2C_QREAD,
  190. CS8409_SPI_CTRL,
  191. CS8409_SPI_TX_DATA,
  192. CS8409_SPI_RX_DATA,
  193. CS8409_SPI_STS,
  194. CS8409_PFE_COEF_W1, /* Parametric filter engine coefficient write 1*/
  195. CS8409_PFE_COEF_W2,
  196. CS8409_PFE_CTRL1,
  197. CS8409_PFE_CTRL2,
  198. CS8409_PRE_SCALE_ATTN1,
  199. CS8409_PRE_SCALE_ATTN2,
  200. CS8409_PFE_COEF_MON1, /* Parametric filter engine coefficient monitor 1*/
  201. CS8409_PFE_COEF_MON2,
  202. CS8409_ASP1_INTRN_STS,
  203. CS8409_ASP2_INTRN_STS,
  204. CS8409_ASP1_RX_SCLK_COUNT,
  205. CS8409_ASP1_TX_SCLK_COUNT,
  206. CS8409_ASP2_RX_SCLK_COUNT,
  207. CS8409_ASP2_TX_SCLK_COUNT,
  208. CS8409_ASP_UNS_RESP_MASK,
  209. CS8409_LOOPBACK_CTRL = 0x80,
  210. CS8409_PAD_CFG_SLW_RATE_CTRL = 0x82, /* Pad Config and Slew Rate Control (CIR = 0x0082) */
  211. };
  212. /* CS42L42 Specific Definitions */
  213. #define CS8409_MAX_CODECS 8
  214. #define CS42L42_VOLUMES (4U)
  215. #define CS42L42_HP_VOL_REAL_MIN (-63)
  216. #define CS42L42_HP_VOL_REAL_MAX (0)
  217. #define CS42L42_AMIC_VOL_REAL_MIN (-97)
  218. #define CS42L42_AMIC_VOL_REAL_MAX (12)
  219. #define CS42L42_REG_AMIC_VOL_MASK (0x00FF)
  220. #define CS42L42_HSTYPE_MASK (0x03)
  221. #define CS42L42_I2C_TIMEOUT_US (20000)
  222. #define CS42L42_I2C_SLEEP_US (2000)
  223. #define CS42L42_PDN_TIMEOUT_US (250000)
  224. #define CS42L42_PDN_SLEEP_US (2000)
  225. #define CS42L42_INIT_TIMEOUT_MS (45)
  226. #define CS42L42_FULL_SCALE_VOL_MASK (2)
  227. #define CS42L42_FULL_SCALE_VOL_0DB (1)
  228. #define CS42L42_FULL_SCALE_VOL_MINUS6DB (0)
  229. /* Dell BULLSEYE / WARLOCK / CYBORG Specific Definitions */
  230. #define CS42L42_I2C_ADDR (0x48 << 1)
  231. #define CS8409_CS42L42_RESET GENMASK(5, 5) /* CS8409_GPIO5 */
  232. #define CS8409_CS42L42_INT GENMASK(4, 4) /* CS8409_GPIO4 */
  233. #define CS8409_CYBORG_SPEAKER_PDN GENMASK(2, 2) /* CS8409_GPIO2 */
  234. #define CS8409_WARLOCK_SPEAKER_PDN GENMASK(1, 1) /* CS8409_GPIO1 */
  235. #define CS8409_CS42L42_HP_PIN_NID CS8409_PIN_ASP1_TRANSMITTER_A
  236. #define CS8409_CS42L42_SPK_PIN_NID CS8409_PIN_ASP2_TRANSMITTER_A
  237. #define CS8409_CS42L42_AMIC_PIN_NID CS8409_PIN_ASP1_RECEIVER_A
  238. #define CS8409_CS42L42_DMIC_PIN_NID CS8409_PIN_DMIC1_IN
  239. #define CS8409_CS42L42_DMIC_ADC_PIN_NID CS8409_PIN_DMIC1
  240. /* Dolphin */
  241. #define DOLPHIN_C0_I2C_ADDR (0x48 << 1)
  242. #define DOLPHIN_C1_I2C_ADDR (0x49 << 1)
  243. #define DOLPHIN_HP_PIN_NID CS8409_PIN_ASP1_TRANSMITTER_A
  244. #define DOLPHIN_LO_PIN_NID CS8409_PIN_ASP1_TRANSMITTER_B
  245. #define DOLPHIN_AMIC_PIN_NID CS8409_PIN_ASP1_RECEIVER_A
  246. #define DOLPHIN_C0_INT GENMASK(4, 4)
  247. #define DOLPHIN_C1_INT GENMASK(0, 0)
  248. #define DOLPHIN_C0_RESET GENMASK(5, 5)
  249. #define DOLPHIN_C1_RESET GENMASK(1, 1)
  250. #define DOLPHIN_WAKE (DOLPHIN_C0_INT | DOLPHIN_C1_INT)
  251. enum {
  252. CS8409_BULLSEYE,
  253. CS8409_WARLOCK,
  254. CS8409_WARLOCK_MLK,
  255. CS8409_WARLOCK_MLK_DUAL_MIC,
  256. CS8409_CYBORG,
  257. CS8409_FIXUPS,
  258. CS8409_DOLPHIN,
  259. CS8409_DOLPHIN_FIXUPS,
  260. CS8409_ODIN,
  261. };
  262. enum {
  263. CS8409_CODEC0,
  264. CS8409_CODEC1
  265. };
  266. enum {
  267. CS42L42_VOL_ADC,
  268. CS42L42_VOL_DAC,
  269. };
  270. #define CS42L42_ADC_VOL_OFFSET (CS42L42_VOL_ADC)
  271. #define CS42L42_DAC_CH0_VOL_OFFSET (CS42L42_VOL_DAC)
  272. #define CS42L42_DAC_CH1_VOL_OFFSET (CS42L42_VOL_DAC + 1)
  273. struct cs8409_i2c_param {
  274. unsigned int addr;
  275. unsigned int value;
  276. };
  277. struct cs8409_cir_param {
  278. unsigned int nid;
  279. unsigned int cir;
  280. unsigned int coeff;
  281. };
  282. struct sub_codec {
  283. struct hda_codec *codec;
  284. unsigned int addr;
  285. unsigned int reset_gpio;
  286. unsigned int irq_mask;
  287. const struct cs8409_i2c_param *init_seq;
  288. unsigned int init_seq_num;
  289. unsigned int hp_jack_in:1;
  290. unsigned int mic_jack_in:1;
  291. unsigned int suspended:1;
  292. unsigned int paged:1;
  293. unsigned int last_page;
  294. unsigned int hsbias_hiz;
  295. unsigned int full_scale_vol:1;
  296. unsigned int no_type_dect:1;
  297. s8 vol[CS42L42_VOLUMES];
  298. };
  299. struct cs8409_spec {
  300. struct hda_gen_spec gen;
  301. struct hda_codec *codec;
  302. struct sub_codec *scodecs[CS8409_MAX_CODECS];
  303. unsigned int num_scodecs;
  304. unsigned int gpio_mask;
  305. unsigned int gpio_dir;
  306. unsigned int gpio_data;
  307. int speaker_pdn_gpio;
  308. struct mutex i2c_mux;
  309. unsigned int i2c_clck_enabled;
  310. unsigned int dev_addr;
  311. struct delayed_work i2c_clk_work;
  312. unsigned int playback_started:1;
  313. unsigned int capture_started:1;
  314. unsigned int init_done:1;
  315. unsigned int build_ctrl_done:1;
  316. /* verb exec op override */
  317. int (*exec_verb)(struct hdac_device *dev, unsigned int cmd, unsigned int flags,
  318. unsigned int *res);
  319. };
  320. extern const struct snd_kcontrol_new cs42l42_dac_volume_mixer;
  321. extern const struct snd_kcontrol_new cs42l42_adc_volume_mixer;
  322. int cs42l42_volume_info(struct snd_kcontrol *kctrl, struct snd_ctl_elem_info *uinfo);
  323. int cs42l42_volume_get(struct snd_kcontrol *kctrl, struct snd_ctl_elem_value *uctrl);
  324. int cs42l42_volume_put(struct snd_kcontrol *kctrl, struct snd_ctl_elem_value *uctrl);
  325. extern const struct hda_pcm_stream cs42l42_48k_pcm_analog_playback;
  326. extern const struct hda_pcm_stream cs42l42_48k_pcm_analog_capture;
  327. extern const struct snd_pci_quirk cs8409_fixup_tbl[];
  328. extern const struct hda_model_fixup cs8409_models[];
  329. extern const struct hda_fixup cs8409_fixups[];
  330. extern const struct hda_verb cs8409_cs42l42_init_verbs[];
  331. extern const struct cs8409_cir_param cs8409_cs42l42_hw_cfg[];
  332. extern const struct cs8409_cir_param cs8409_cs42l42_bullseye_atn[];
  333. extern struct sub_codec cs8409_cs42l42_codec;
  334. extern const struct hda_verb dolphin_init_verbs[];
  335. extern const struct cs8409_cir_param dolphin_hw_cfg[];
  336. extern struct sub_codec dolphin_cs42l42_0;
  337. extern struct sub_codec dolphin_cs42l42_1;
  338. void cs8409_cs42l42_fixups(struct hda_codec *codec, const struct hda_fixup *fix, int action);
  339. void dolphin_fixups(struct hda_codec *codec, const struct hda_fixup *fix, int action);
  340. #endif