ac97_codec.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418
  1. /* SPDX-License-Identifier: GPL-2.0+
  2. *
  3. * Copyright (c) by Jaroslav Kysela <[email protected]>
  4. * Universal interface for Audio Codec '97
  5. *
  6. * For more details look to AC '97 component specification revision 2.1
  7. * by Intel Corporation (http://developer.intel.com).
  8. */
  9. #ifndef __SOUND_AC97_CODEC_H
  10. #define __SOUND_AC97_CODEC_H
  11. #include <linux/bitops.h>
  12. #include <linux/device.h>
  13. #include <linux/workqueue.h>
  14. #include <sound/ac97/regs.h>
  15. #include <sound/pcm.h>
  16. #include <sound/control.h>
  17. #include <sound/info.h>
  18. /* maximum number of devices on the AC97 bus */
  19. #define AC97_BUS_MAX_DEVICES 4
  20. /* specific - SigmaTel */
  21. #define AC97_SIGMATEL_OUTSEL 0x64 /* Output Select, STAC9758 */
  22. #define AC97_SIGMATEL_INSEL 0x66 /* Input Select, STAC9758 */
  23. #define AC97_SIGMATEL_IOMISC 0x68 /* STAC9758 */
  24. #define AC97_SIGMATEL_ANALOG 0x6c /* Analog Special */
  25. #define AC97_SIGMATEL_DAC2INVERT 0x6e
  26. #define AC97_SIGMATEL_BIAS1 0x70
  27. #define AC97_SIGMATEL_BIAS2 0x72
  28. #define AC97_SIGMATEL_VARIOUS 0x72 /* STAC9758 */
  29. #define AC97_SIGMATEL_MULTICHN 0x74 /* Multi-Channel programming */
  30. #define AC97_SIGMATEL_CIC1 0x76
  31. #define AC97_SIGMATEL_CIC2 0x78
  32. /* specific - Analog Devices */
  33. #define AC97_AD_TEST 0x5a /* test register */
  34. #define AC97_AD_TEST2 0x5c /* undocumented test register 2 */
  35. #define AC97_AD_HPFD_SHIFT 12 /* High Pass Filter Disable */
  36. #define AC97_AD_CODEC_CFG 0x70 /* codec configuration */
  37. #define AC97_AD_JACK_SPDIF 0x72 /* Jack Sense & S/PDIF */
  38. #define AC97_AD_SERIAL_CFG 0x74 /* Serial Configuration */
  39. #define AC97_AD_MISC 0x76 /* Misc Control Bits */
  40. #define AC97_AD_VREFD_SHIFT 2 /* V_REFOUT Disable (AD1888) */
  41. /* specific - Cirrus Logic */
  42. #define AC97_CSR_ACMODE 0x5e /* AC Mode Register */
  43. #define AC97_CSR_MISC_CRYSTAL 0x60 /* Misc Crystal Control */
  44. #define AC97_CSR_SPDIF 0x68 /* S/PDIF Register */
  45. #define AC97_CSR_SERIAL 0x6a /* Serial Port Control */
  46. #define AC97_CSR_SPECF_ADDR 0x6c /* Special Feature Address */
  47. #define AC97_CSR_SPECF_DATA 0x6e /* Special Feature Data */
  48. #define AC97_CSR_BDI_STATUS 0x7a /* BDI Status */
  49. /* specific - Conexant */
  50. #define AC97_CXR_AUDIO_MISC 0x5c
  51. #define AC97_CXR_SPDIFEN (1<<3)
  52. #define AC97_CXR_COPYRGT (1<<2)
  53. #define AC97_CXR_SPDIF_MASK (3<<0)
  54. #define AC97_CXR_SPDIF_PCM 0x0
  55. #define AC97_CXR_SPDIF_AC3 0x2
  56. /* specific - ALC */
  57. #define AC97_ALC650_SPDIF_INPUT_STATUS1 0x60
  58. /* S/PDIF input status 1 bit defines */
  59. #define AC97_ALC650_PRO 0x0001 /* Professional status */
  60. #define AC97_ALC650_NAUDIO 0x0002 /* Non audio stream */
  61. #define AC97_ALC650_COPY 0x0004 /* Copyright status */
  62. #define AC97_ALC650_PRE 0x0038 /* Preemphasis status */
  63. #define AC97_ALC650_PRE_SHIFT 3
  64. #define AC97_ALC650_MODE 0x00C0 /* Preemphasis status */
  65. #define AC97_ALC650_MODE_SHIFT 6
  66. #define AC97_ALC650_CC_MASK 0x7f00 /* Category Code mask */
  67. #define AC97_ALC650_CC_SHIFT 8
  68. #define AC97_ALC650_L 0x8000 /* Generation Level status */
  69. #define AC97_ALC650_SPDIF_INPUT_STATUS2 0x62
  70. /* S/PDIF input status 2 bit defines */
  71. #define AC97_ALC650_SOUCE_MASK 0x000f /* Source number */
  72. #define AC97_ALC650_CHANNEL_MASK 0x00f0 /* Channel number */
  73. #define AC97_ALC650_CHANNEL_SHIFT 4
  74. #define AC97_ALC650_SPSR_MASK 0x0f00 /* S/PDIF Sample Rate bits */
  75. #define AC97_ALC650_SPSR_SHIFT 8
  76. #define AC97_ALC650_SPSR_44K 0x0000 /* Use 44.1kHz Sample rate */
  77. #define AC97_ALC650_SPSR_48K 0x0200 /* Use 48kHz Sample rate */
  78. #define AC97_ALC650_SPSR_32K 0x0300 /* Use 32kHz Sample rate */
  79. #define AC97_ALC650_CLOCK_ACCURACY 0x3000 /* Clock accuracy */
  80. #define AC97_ALC650_CLOCK_SHIFT 12
  81. #define AC97_ALC650_CLOCK_LOCK 0x4000 /* Clock locked status */
  82. #define AC97_ALC650_V 0x8000 /* Validity status */
  83. #define AC97_ALC650_SURR_DAC_VOL 0x64
  84. #define AC97_ALC650_LFE_DAC_VOL 0x66
  85. #define AC97_ALC650_UNKNOWN1 0x68
  86. #define AC97_ALC650_MULTICH 0x6a
  87. #define AC97_ALC650_UNKNOWN2 0x6c
  88. #define AC97_ALC650_REVISION 0x6e
  89. #define AC97_ALC650_UNKNOWN3 0x70
  90. #define AC97_ALC650_UNKNOWN4 0x72
  91. #define AC97_ALC650_MISC 0x74
  92. #define AC97_ALC650_GPIO_SETUP 0x76
  93. #define AC97_ALC650_GPIO_STATUS 0x78
  94. #define AC97_ALC650_CLOCK 0x7a
  95. /* specific - Yamaha YMF7x3 */
  96. #define AC97_YMF7X3_DIT_CTRL 0x66 /* DIT Control (YMF743) / 2 (YMF753) */
  97. #define AC97_YMF7X3_3D_MODE_SEL 0x68 /* 3D Mode Select */
  98. /* specific - C-Media */
  99. #define AC97_CM9738_VENDOR_CTRL 0x5a
  100. #define AC97_CM9739_MULTI_CHAN 0x64
  101. #define AC97_CM9739_SPDIF_IN_STATUS 0x68 /* 32bit */
  102. #define AC97_CM9739_SPDIF_CTRL 0x6c
  103. /* specific - wolfson */
  104. #define AC97_WM97XX_FMIXER_VOL 0x72
  105. #define AC97_WM9704_RMIXER_VOL 0x74
  106. #define AC97_WM9704_TEST 0x5a
  107. #define AC97_WM9704_RPCM_VOL 0x70
  108. #define AC97_WM9711_OUT3VOL 0x16
  109. /* ac97->scaps */
  110. #define AC97_SCAP_AUDIO (1<<0) /* audio codec 97 */
  111. #define AC97_SCAP_MODEM (1<<1) /* modem codec 97 */
  112. #define AC97_SCAP_SURROUND_DAC (1<<2) /* surround L&R DACs are present */
  113. #define AC97_SCAP_CENTER_LFE_DAC (1<<3) /* center and LFE DACs are present */
  114. #define AC97_SCAP_SKIP_AUDIO (1<<4) /* skip audio part of codec */
  115. #define AC97_SCAP_SKIP_MODEM (1<<5) /* skip modem part of codec */
  116. #define AC97_SCAP_INDEP_SDIN (1<<6) /* independent SDIN */
  117. #define AC97_SCAP_INV_EAPD (1<<7) /* inverted EAPD */
  118. #define AC97_SCAP_DETECT_BY_VENDOR (1<<8) /* use vendor registers for read tests */
  119. #define AC97_SCAP_NO_SPDIF (1<<9) /* don't build SPDIF controls */
  120. #define AC97_SCAP_EAPD_LED (1<<10) /* EAPD as mute LED */
  121. #define AC97_SCAP_POWER_SAVE (1<<11) /* capable for aggressive power-saving */
  122. /* ac97->flags */
  123. #define AC97_HAS_PC_BEEP (1<<0) /* force PC Speaker usage */
  124. #define AC97_AD_MULTI (1<<1) /* Analog Devices - multi codecs */
  125. #define AC97_CS_SPDIF (1<<2) /* Cirrus Logic uses funky SPDIF */
  126. #define AC97_CX_SPDIF (1<<3) /* Conexant's spdif interface */
  127. #define AC97_STEREO_MUTES (1<<4) /* has stereo mute bits */
  128. #define AC97_DOUBLE_RATE (1<<5) /* supports double rate playback */
  129. #define AC97_HAS_NO_MASTER_VOL (1<<6) /* no Master volume */
  130. #define AC97_HAS_NO_PCM_VOL (1<<7) /* no PCM volume */
  131. #define AC97_DEFAULT_POWER_OFF (1<<8) /* no RESET write */
  132. #define AC97_MODEM_PATCH (1<<9) /* modem patch */
  133. #define AC97_HAS_NO_REC_GAIN (1<<10) /* no Record gain */
  134. #define AC97_HAS_NO_PHONE (1<<11) /* no PHONE volume */
  135. #define AC97_HAS_NO_PC_BEEP (1<<12) /* no PC Beep volume */
  136. #define AC97_HAS_NO_VIDEO (1<<13) /* no Video volume */
  137. #define AC97_HAS_NO_CD (1<<14) /* no CD volume */
  138. #define AC97_HAS_NO_MIC (1<<15) /* no MIC volume */
  139. #define AC97_HAS_NO_TONE (1<<16) /* no Tone volume */
  140. #define AC97_HAS_NO_STD_PCM (1<<17) /* no standard AC97 PCM volume and mute */
  141. #define AC97_HAS_NO_AUX (1<<18) /* no standard AC97 AUX volume and mute */
  142. #define AC97_HAS_8CH (1<<19) /* supports 8-channel output */
  143. /* rates indexes */
  144. #define AC97_RATES_FRONT_DAC 0
  145. #define AC97_RATES_SURR_DAC 1
  146. #define AC97_RATES_LFE_DAC 2
  147. #define AC97_RATES_ADC 3
  148. #define AC97_RATES_MIC_ADC 4
  149. #define AC97_RATES_SPDIF 5
  150. #define AC97_NUM_GPIOS 16
  151. /*
  152. *
  153. */
  154. struct snd_ac97;
  155. struct snd_ac97_gpio_priv;
  156. struct snd_pcm_chmap;
  157. struct snd_ac97_build_ops {
  158. int (*build_3d) (struct snd_ac97 *ac97);
  159. int (*build_specific) (struct snd_ac97 *ac97);
  160. int (*build_spdif) (struct snd_ac97 *ac97);
  161. int (*build_post_spdif) (struct snd_ac97 *ac97);
  162. #ifdef CONFIG_PM
  163. void (*suspend) (struct snd_ac97 *ac97);
  164. void (*resume) (struct snd_ac97 *ac97);
  165. #endif
  166. void (*update_jacks) (struct snd_ac97 *ac97); /* for jack-sharing */
  167. };
  168. struct snd_ac97_bus_ops {
  169. void (*reset) (struct snd_ac97 *ac97);
  170. void (*warm_reset)(struct snd_ac97 *ac97);
  171. void (*write) (struct snd_ac97 *ac97, unsigned short reg, unsigned short val);
  172. unsigned short (*read) (struct snd_ac97 *ac97, unsigned short reg);
  173. void (*wait) (struct snd_ac97 *ac97);
  174. void (*init) (struct snd_ac97 *ac97);
  175. };
  176. struct snd_ac97_bus {
  177. /* -- lowlevel (hardware) driver specific -- */
  178. const struct snd_ac97_bus_ops *ops;
  179. void *private_data;
  180. void (*private_free) (struct snd_ac97_bus *bus);
  181. /* --- */
  182. struct snd_card *card;
  183. unsigned short num; /* bus number */
  184. unsigned short no_vra: 1, /* bridge doesn't support VRA */
  185. dra: 1, /* bridge supports double rate */
  186. isdin: 1;/* independent SDIN */
  187. unsigned int clock; /* AC'97 base clock (usually 48000Hz) */
  188. spinlock_t bus_lock; /* used mainly for slot allocation */
  189. unsigned short used_slots[2][4]; /* actually used PCM slots */
  190. unsigned short pcms_count; /* count of PCMs */
  191. struct ac97_pcm *pcms;
  192. struct snd_ac97 *codec[4];
  193. struct snd_info_entry *proc;
  194. };
  195. /* static resolution table */
  196. struct snd_ac97_res_table {
  197. unsigned short reg; /* register */
  198. unsigned short bits; /* resolution bitmask */
  199. };
  200. struct snd_ac97_template {
  201. void *private_data;
  202. void (*private_free) (struct snd_ac97 *ac97);
  203. struct pci_dev *pci; /* assigned PCI device - used for quirks */
  204. unsigned short num; /* number of codec: 0 = primary, 1 = secondary */
  205. unsigned short addr; /* physical address of codec [0-3] */
  206. unsigned int scaps; /* driver capabilities */
  207. const struct snd_ac97_res_table *res_table; /* static resolution */
  208. };
  209. struct snd_ac97 {
  210. /* -- lowlevel (hardware) driver specific -- */
  211. const struct snd_ac97_build_ops *build_ops;
  212. void *private_data;
  213. void (*private_free) (struct snd_ac97 *ac97);
  214. /* --- */
  215. struct snd_ac97_bus *bus;
  216. struct pci_dev *pci; /* assigned PCI device - used for quirks */
  217. struct snd_info_entry *proc;
  218. struct snd_info_entry *proc_regs;
  219. unsigned short subsystem_vendor;
  220. unsigned short subsystem_device;
  221. struct mutex reg_mutex;
  222. struct mutex page_mutex; /* mutex for AD18xx multi-codecs and paging (2.3) */
  223. unsigned short num; /* number of codec: 0 = primary, 1 = secondary */
  224. unsigned short addr; /* physical address of codec [0-3] */
  225. unsigned int id; /* identification of codec */
  226. unsigned short caps; /* capabilities (register 0) */
  227. unsigned short ext_id; /* extended feature identification (register 28) */
  228. unsigned short ext_mid; /* extended modem ID (register 3C) */
  229. const struct snd_ac97_res_table *res_table; /* static resolution */
  230. unsigned int scaps; /* driver capabilities */
  231. unsigned int flags; /* specific code */
  232. unsigned int rates[6]; /* see AC97_RATES_* defines */
  233. unsigned int spdif_status;
  234. unsigned short regs[0x80]; /* register cache */
  235. DECLARE_BITMAP(reg_accessed, 0x80); /* bit flags */
  236. union { /* vendor specific code */
  237. struct {
  238. unsigned short unchained[3]; // 0 = C34, 1 = C79, 2 = C69
  239. unsigned short chained[3]; // 0 = C34, 1 = C79, 2 = C69
  240. unsigned short id[3]; // codec IDs (lower 16-bit word)
  241. unsigned short pcmreg[3]; // PCM registers
  242. unsigned short codec_cfg[3]; // CODEC_CFG bits
  243. unsigned char swap_mic_linein; // AD1986/AD1986A only
  244. unsigned char lo_as_master; /* LO as master */
  245. } ad18xx;
  246. unsigned int dev_flags; /* device specific */
  247. } spec;
  248. /* jack-sharing info */
  249. unsigned char indep_surround;
  250. unsigned char channel_mode;
  251. #ifdef CONFIG_SND_AC97_POWER_SAVE
  252. unsigned int power_up; /* power states */
  253. struct delayed_work power_work;
  254. #endif
  255. struct device dev;
  256. struct snd_ac97_gpio_priv *gpio_priv;
  257. struct snd_pcm_chmap *chmaps[2]; /* channel-maps (optional) */
  258. };
  259. #define to_ac97_t(d) container_of(d, struct snd_ac97, dev)
  260. /* conditions */
  261. static inline int ac97_is_audio(struct snd_ac97 * ac97)
  262. {
  263. return (ac97->scaps & AC97_SCAP_AUDIO);
  264. }
  265. static inline int ac97_is_modem(struct snd_ac97 * ac97)
  266. {
  267. return (ac97->scaps & AC97_SCAP_MODEM);
  268. }
  269. static inline int ac97_is_rev22(struct snd_ac97 * ac97)
  270. {
  271. return (ac97->ext_id & AC97_EI_REV_MASK) >= AC97_EI_REV_22;
  272. }
  273. static inline int ac97_can_amap(struct snd_ac97 * ac97)
  274. {
  275. return (ac97->ext_id & AC97_EI_AMAP) != 0;
  276. }
  277. static inline int ac97_can_spdif(struct snd_ac97 * ac97)
  278. {
  279. return (ac97->ext_id & AC97_EI_SPDIF) != 0;
  280. }
  281. /* functions */
  282. /* create new AC97 bus */
  283. int snd_ac97_bus(struct snd_card *card, int num,
  284. const struct snd_ac97_bus_ops *ops,
  285. void *private_data, struct snd_ac97_bus **rbus);
  286. /* create mixer controls */
  287. int snd_ac97_mixer(struct snd_ac97_bus *bus, struct snd_ac97_template *template,
  288. struct snd_ac97 **rac97);
  289. const char *snd_ac97_get_short_name(struct snd_ac97 *ac97);
  290. void snd_ac97_write(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
  291. unsigned short snd_ac97_read(struct snd_ac97 *ac97, unsigned short reg);
  292. void snd_ac97_write_cache(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
  293. int snd_ac97_update(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
  294. int snd_ac97_update_bits(struct snd_ac97 *ac97, unsigned short reg, unsigned short mask, unsigned short value);
  295. #ifdef CONFIG_SND_AC97_POWER_SAVE
  296. int snd_ac97_update_power(struct snd_ac97 *ac97, int reg, int powerup);
  297. #else
  298. static inline int snd_ac97_update_power(struct snd_ac97 *ac97, int reg,
  299. int powerup)
  300. {
  301. return 0;
  302. }
  303. #endif
  304. #ifdef CONFIG_PM
  305. void snd_ac97_suspend(struct snd_ac97 *ac97);
  306. void snd_ac97_resume(struct snd_ac97 *ac97);
  307. #endif
  308. int snd_ac97_reset(struct snd_ac97 *ac97, bool try_warm, unsigned int id,
  309. unsigned int id_mask);
  310. /* quirk types */
  311. enum {
  312. AC97_TUNE_DEFAULT = -1, /* use default from quirk list (not valid in list) */
  313. AC97_TUNE_NONE = 0, /* nothing extra to do */
  314. AC97_TUNE_HP_ONLY, /* headphone (true line-out) control as master only */
  315. AC97_TUNE_SWAP_HP, /* swap headphone and master controls */
  316. AC97_TUNE_SWAP_SURROUND, /* swap master and surround controls */
  317. AC97_TUNE_AD_SHARING, /* for AD1985, turn on OMS bit and use headphone */
  318. AC97_TUNE_ALC_JACK, /* for Realtek, enable JACK detection */
  319. AC97_TUNE_INV_EAPD, /* inverted EAPD implementation */
  320. AC97_TUNE_MUTE_LED, /* EAPD bit works as mute LED */
  321. AC97_TUNE_HP_MUTE_LED, /* EAPD bit works as mute LED, use headphone control as master */
  322. };
  323. struct ac97_quirk {
  324. unsigned short subvendor; /* PCI subsystem vendor id */
  325. unsigned short subdevice; /* PCI subsystem device id */
  326. unsigned short mask; /* device id bit mask, 0 = accept all */
  327. unsigned int codec_id; /* codec id (if any), 0 = accept all */
  328. const char *name; /* name shown as info */
  329. int type; /* quirk type above */
  330. };
  331. int snd_ac97_tune_hardware(struct snd_ac97 *ac97,
  332. const struct ac97_quirk *quirk,
  333. const char *override);
  334. int snd_ac97_set_rate(struct snd_ac97 *ac97, int reg, unsigned int rate);
  335. /*
  336. * PCM allocation
  337. */
  338. enum ac97_pcm_cfg {
  339. AC97_PCM_CFG_FRONT = 2,
  340. AC97_PCM_CFG_REAR = 10, /* alias surround */
  341. AC97_PCM_CFG_LFE = 11, /* center + lfe */
  342. AC97_PCM_CFG_40 = 4, /* front + rear */
  343. AC97_PCM_CFG_51 = 6, /* front + rear + center/lfe */
  344. AC97_PCM_CFG_SPDIF = 20
  345. };
  346. struct ac97_pcm {
  347. struct snd_ac97_bus *bus;
  348. unsigned int stream: 1, /* stream type: 1 = capture */
  349. exclusive: 1, /* exclusive mode, don't override with other pcms */
  350. copy_flag: 1, /* lowlevel driver must fill all entries */
  351. spdif: 1; /* spdif pcm */
  352. unsigned short aslots; /* active slots */
  353. unsigned short cur_dbl; /* current double-rate state */
  354. unsigned int rates; /* available rates */
  355. struct {
  356. unsigned short slots; /* driver input: requested AC97 slot numbers */
  357. unsigned short rslots[4]; /* allocated slots per codecs */
  358. unsigned char rate_table[4];
  359. struct snd_ac97 *codec[4]; /* allocated codecs */
  360. } r[2]; /* 0 = standard rates, 1 = double rates */
  361. unsigned long private_value; /* used by the hardware driver */
  362. };
  363. int snd_ac97_pcm_assign(struct snd_ac97_bus *ac97,
  364. unsigned short pcms_count,
  365. const struct ac97_pcm *pcms);
  366. int snd_ac97_pcm_open(struct ac97_pcm *pcm, unsigned int rate,
  367. enum ac97_pcm_cfg cfg, unsigned short slots);
  368. int snd_ac97_pcm_close(struct ac97_pcm *pcm);
  369. int snd_ac97_pcm_double_rate_rules(struct snd_pcm_runtime *runtime);
  370. /* ad hoc AC97 device driver access */
  371. extern struct bus_type ac97_bus_type;
  372. /* AC97 platform_data adding function */
  373. static inline void snd_ac97_dev_add_pdata(struct snd_ac97 *ac97, void *data)
  374. {
  375. ac97->dev.platform_data = data;
  376. }
  377. #endif /* __SOUND_AC97_CODEC_H */