ak4114.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. #ifndef __SOUND_AK4114_H
  2. #define __SOUND_AK4114_H
  3. /*
  4. * Routines for Asahi Kasei AK4114
  5. * Copyright (c) by Jaroslav Kysela <perex@perex.cz>,
  6. *
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation; either version 2 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program; if not, write to the Free Software
  20. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  21. *
  22. */
  23. /* AK4114 registers */
  24. #define AK4114_REG_PWRDN 0x00 /* power down */
  25. #define AK4114_REG_FORMAT 0x01 /* format control */
  26. #define AK4114_REG_IO0 0x02 /* input/output control */
  27. #define AK4114_REG_IO1 0x03 /* input/output control */
  28. #define AK4114_REG_INT0_MASK 0x04 /* interrupt0 mask */
  29. #define AK4114_REG_INT1_MASK 0x05 /* interrupt1 mask */
  30. #define AK4114_REG_RCS0 0x06 /* receiver status 0 */
  31. #define AK4114_REG_RCS1 0x07 /* receiver status 1 */
  32. #define AK4114_REG_RXCSB0 0x08 /* RX channel status byte 0 */
  33. #define AK4114_REG_RXCSB1 0x09 /* RX channel status byte 1 */
  34. #define AK4114_REG_RXCSB2 0x0a /* RX channel status byte 2 */
  35. #define AK4114_REG_RXCSB3 0x0b /* RX channel status byte 3 */
  36. #define AK4114_REG_RXCSB4 0x0c /* RX channel status byte 4 */
  37. #define AK4114_REG_TXCSB0 0x0d /* TX channel status byte 0 */
  38. #define AK4114_REG_TXCSB1 0x0e /* TX channel status byte 1 */
  39. #define AK4114_REG_TXCSB2 0x0f /* TX channel status byte 2 */
  40. #define AK4114_REG_TXCSB3 0x10 /* TX channel status byte 3 */
  41. #define AK4114_REG_TXCSB4 0x11 /* TX channel status byte 4 */
  42. #define AK4114_REG_Pc0 0x12 /* burst preamble Pc byte 0 */
  43. #define AK4114_REG_Pc1 0x13 /* burst preamble Pc byte 1 */
  44. #define AK4114_REG_Pd0 0x14 /* burst preamble Pd byte 0 */
  45. #define AK4114_REG_Pd1 0x15 /* burst preamble Pd byte 1 */
  46. #define AK4114_REG_QSUB_ADDR 0x16 /* Q-subcode address + control */
  47. #define AK4114_REG_QSUB_TRACK 0x17 /* Q-subcode track */
  48. #define AK4114_REG_QSUB_INDEX 0x18 /* Q-subcode index */
  49. #define AK4114_REG_QSUB_MINUTE 0x19 /* Q-subcode minute */
  50. #define AK4114_REG_QSUB_SECOND 0x1a /* Q-subcode second */
  51. #define AK4114_REG_QSUB_FRAME 0x1b /* Q-subcode frame */
  52. #define AK4114_REG_QSUB_ZERO 0x1c /* Q-subcode zero */
  53. #define AK4114_REG_QSUB_ABSMIN 0x1d /* Q-subcode absolute minute */
  54. #define AK4114_REG_QSUB_ABSSEC 0x1e /* Q-subcode absolute second */
  55. #define AK4114_REG_QSUB_ABSFRM 0x1f /* Q-subcode absolute frame */
  56. /* sizes */
  57. #define AK4114_REG_RXCSB_SIZE ((AK4114_REG_RXCSB4-AK4114_REG_RXCSB0)+1)
  58. #define AK4114_REG_TXCSB_SIZE ((AK4114_REG_TXCSB4-AK4114_REG_TXCSB0)+1)
  59. #define AK4114_REG_QSUB_SIZE ((AK4114_REG_QSUB_ABSFRM-AK4114_REG_QSUB_ADDR)+1)
  60. /* AK4117_REG_PWRDN bits */
  61. #define AK4114_CS12 (1<<7) /* Channel Status Select */
  62. #define AK4114_BCU (1<<6) /* Block Start & C/U Output Mode */
  63. #define AK4114_CM1 (1<<5) /* Master Clock Operation Select */
  64. #define AK4114_CM0 (1<<4) /* Master Clock Operation Select */
  65. #define AK4114_OCKS1 (1<<3) /* Master Clock Frequency Select */
  66. #define AK4114_OCKS0 (1<<2) /* Master Clock Frequency Select */
  67. #define AK4114_PWN (1<<1) /* 0 = power down, 1 = normal operation */
  68. #define AK4114_RST (1<<0) /* 0 = reset & initialize (except this register), 1 = normal operation */
  69. /* AK4114_REQ_FORMAT bits */
  70. #define AK4114_MONO (1<<7) /* Double Sampling Frequency Mode: 0 = stereo, 1 = mono */
  71. #define AK4114_DIF2 (1<<6) /* Audio Data Control */
  72. #define AK4114_DIF1 (1<<5) /* Audio Data Control */
  73. #define AK4114_DIF0 (1<<4) /* Audio Data Control */
  74. #define AK4114_DIF_16R (0) /* STDO: 16-bit, right justified */
  75. #define AK4114_DIF_18R (AK4114_DIF0) /* STDO: 18-bit, right justified */
  76. #define AK4114_DIF_20R (AK4114_DIF1) /* STDO: 20-bit, right justified */
  77. #define AK4114_DIF_24R (AK4114_DIF1|AK4114_DIF0) /* STDO: 24-bit, right justified */
  78. #define AK4114_DIF_24L (AK4114_DIF2) /* STDO: 24-bit, left justified */
  79. #define AK4114_DIF_24I2S (AK4114_DIF2|AK4114_DIF0) /* STDO: I2S */
  80. #define AK4114_DIF_I24L (AK4114_DIF2|AK4114_DIF1) /* STDO: 24-bit, left justified; LRCLK, BICK = Input */
  81. #define AK4114_DIF_I24I2S (AK4114_DIF2|AK4114_DIF1|AK4114_DIF0) /* STDO: I2S; LRCLK, BICK = Input */
  82. #define AK4114_DEAU (1<<3) /* Deemphasis Autodetect Enable (1 = enable) */
  83. #define AK4114_DEM1 (1<<2) /* 32kHz-48kHz Deemphasis Control */
  84. #define AK4114_DEM0 (1<<1) /* 32kHz-48kHz Deemphasis Control */
  85. #define AK4114_DEM_44KHZ (0)
  86. #define AK4114_DEM_48KHZ (AK4114_DEM1)
  87. #define AK4114_DEM_32KHZ (AK4114_DEM0|AK4114_DEM1)
  88. #define AK4114_DEM_96KHZ (AK4114_DEM1) /* DFS must be set */
  89. #define AK4114_DFS (1<<0) /* 96kHz Deemphasis Control */
  90. /* AK4114_REG_IO0 */
  91. #define AK4114_TX1E (1<<7) /* TX1 Output Enable (1 = enable) */
  92. #define AK4114_OPS12 (1<<6) /* Output Data Selector for TX1 pin */
  93. #define AK4114_OPS11 (1<<5) /* Output Data Selector for TX1 pin */
  94. #define AK4114_OPS10 (1<<4) /* Output Data Selector for TX1 pin */
  95. #define AK4114_TX0E (1<<3) /* TX0 Output Enable (1 = enable) */
  96. #define AK4114_OPS02 (1<<2) /* Output Data Selector for TX0 pin */
  97. #define AK4114_OPS01 (1<<1) /* Output Data Selector for TX0 pin */
  98. #define AK4114_OPS00 (1<<0) /* Output Data Selector for TX0 pin */
  99. /* AK4114_REG_IO1 */
  100. #define AK4114_EFH1 (1<<7) /* Interrupt 0 pin Hold */
  101. #define AK4114_EFH0 (1<<6) /* Interrupt 0 pin Hold */
  102. #define AK4114_EFH_512 (0)
  103. #define AK4114_EFH_1024 (AK4114_EFH0)
  104. #define AK4114_EFH_2048 (AK4114_EFH1)
  105. #define AK4114_EFH_4096 (AK4114_EFH1|AK4114_EFH0)
  106. #define AK4114_UDIT (1<<5) /* U-bit Control for DIT (0 = fixed '0', 1 = recovered) */
  107. #define AK4114_TLR (1<<4) /* Double Sampling Frequency Select for DIT (0 = L channel, 1 = R channel) */
  108. #define AK4114_DIT (1<<3) /* TX1 out: 0 = Through Data (RX data), 1 = Transmit Data (DAUX data) */
  109. #define AK4114_IPS2 (1<<2) /* Input Recovery Data Select */
  110. #define AK4114_IPS1 (1<<1) /* Input Recovery Data Select */
  111. #define AK4114_IPS0 (1<<0) /* Input Recovery Data Select */
  112. #define AK4114_IPS(x) ((x)&7)
  113. /* AK4114_REG_INT0_MASK && AK4114_REG_INT1_MASK*/
  114. #define AK4117_MQI (1<<7) /* mask enable for QINT bit */
  115. #define AK4117_MAT (1<<6) /* mask enable for AUTO bit */
  116. #define AK4117_MCI (1<<5) /* mask enable for CINT bit */
  117. #define AK4117_MUL (1<<4) /* mask enable for UNLOCK bit */
  118. #define AK4117_MDTS (1<<3) /* mask enable for DTSCD bit */
  119. #define AK4117_MPE (1<<2) /* mask enable for PEM bit */
  120. #define AK4117_MAN (1<<1) /* mask enable for AUDN bit */
  121. #define AK4117_MPR (1<<0) /* mask enable for PAR bit */
  122. /* AK4114_REG_RCS0 */
  123. #define AK4114_QINT (1<<7) /* Q-subcode buffer interrupt, 0 = no change, 1 = changed */
  124. #define AK4114_AUTO (1<<6) /* Non-PCM or DTS stream auto detection, 0 = no detect, 1 = detect */
  125. #define AK4114_CINT (1<<5) /* channel status buffer interrupt, 0 = no change, 1 = change */
  126. #define AK4114_UNLCK (1<<4) /* PLL lock status, 0 = lock, 1 = unlock */
  127. #define AK4114_DTSCD (1<<3) /* DTS-CD Detect, 0 = No detect, 1 = Detect */
  128. #define AK4114_PEM (1<<2) /* Pre-emphasis Detect, 0 = OFF, 1 = ON */
  129. #define AK4114_AUDION (1<<1) /* audio bit output, 0 = audio, 1 = non-audio */
  130. #define AK4114_PAR (1<<0) /* parity error or biphase error status, 0 = no error, 1 = error */
  131. /* AK4114_REG_RCS1 */
  132. #define AK4114_FS3 (1<<7) /* sampling frequency detection */
  133. #define AK4114_FS2 (1<<6)
  134. #define AK4114_FS1 (1<<5)
  135. #define AK4114_FS0 (1<<4)
  136. #define AK4114_FS_44100HZ (0)
  137. #define AK4114_FS_48000HZ (AK4114_FS1)
  138. #define AK4114_FS_32000HZ (AK4114_FS1|AK4114_FS0)
  139. #define AK4114_FS_88200HZ (AK4114_FS3)
  140. #define AK4114_FS_96000HZ (AK4114_FS3|AK4114_FS1)
  141. #define AK4114_FS_176400HZ (AK4114_FS3|AK4114_FS2)
  142. #define AK4114_FS_192000HZ (AK4114_FS3|AK4114_FS2|AK4114_FS1)
  143. #define AK4114_V (1<<3) /* Validity of Channel Status, 0 = Valid, 1 = Invalid */
  144. #define AK4114_QCRC (1<<1) /* CRC for Q-subcode, 0 = no error, 1 = error */
  145. #define AK4114_CCRC (1<<0) /* CRC for channel status, 0 = no error, 1 = error */
  146. /* flags for snd_ak4114_check_rate_and_errors() */
  147. #define AK4114_CHECK_NO_STAT (1<<0) /* no statistics */
  148. #define AK4114_CHECK_NO_RATE (1<<1) /* no rate check */
  149. #define AK4114_CONTROLS 15
  150. typedef void (ak4114_write_t)(void *private_data, unsigned char addr, unsigned char data);
  151. typedef unsigned char (ak4114_read_t)(void *private_data, unsigned char addr);
  152. struct ak4114 {
  153. struct snd_card *card;
  154. ak4114_write_t * write;
  155. ak4114_read_t * read;
  156. void * private_data;
  157. atomic_t wq_processing;
  158. struct mutex reinit_mutex;
  159. spinlock_t lock;
  160. unsigned char regmap[6];
  161. unsigned char txcsb[5];
  162. struct snd_kcontrol *kctls[AK4114_CONTROLS];
  163. struct snd_pcm_substream *playback_substream;
  164. struct snd_pcm_substream *capture_substream;
  165. unsigned long parity_errors;
  166. unsigned long v_bit_errors;
  167. unsigned long qcrc_errors;
  168. unsigned long ccrc_errors;
  169. unsigned char rcs0;
  170. unsigned char rcs1;
  171. struct delayed_work work;
  172. unsigned int check_flags;
  173. void *change_callback_private;
  174. void (*change_callback)(struct ak4114 *ak4114, unsigned char c0, unsigned char c1);
  175. };
  176. int snd_ak4114_create(struct snd_card *card,
  177. ak4114_read_t *read, ak4114_write_t *write,
  178. const unsigned char pgm[6], const unsigned char txcsb[5],
  179. void *private_data, struct ak4114 **r_ak4114);
  180. void snd_ak4114_reg_write(struct ak4114 *ak4114, unsigned char reg, unsigned char mask, unsigned char val);
  181. void snd_ak4114_reinit(struct ak4114 *ak4114);
  182. int snd_ak4114_build(struct ak4114 *ak4114,
  183. struct snd_pcm_substream *playback_substream,
  184. struct snd_pcm_substream *capture_substream);
  185. int snd_ak4114_external_rate(struct ak4114 *ak4114);
  186. int snd_ak4114_check_rate_and_errors(struct ak4114 *ak4114, unsigned int flags);
  187. #ifdef CONFIG_PM
  188. void snd_ak4114_suspend(struct ak4114 *chip);
  189. void snd_ak4114_resume(struct ak4114 *chip);
  190. #else
  191. static inline void snd_ak4114_suspend(struct ak4114 *chip) {}
  192. static inline void snd_ak4114_resume(struct ak4114 *chip) {}
  193. #endif
  194. #endif /* __SOUND_AK4114_H */