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