1 /* $OpenBSD: ac97.h,v 1.27 2018/04/11 04:48:31 ratchov Exp $ */ 2 3 /* 4 * Copyright (c) 1999 Constantine Sapuntzakis 5 * 6 * Author: Constantine Sapuntzakis <csapuntz@stanford.edu> 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY CONSTANTINE SAPUNTZAKIS AND CONTRIBUTORS 18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 20 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS 21 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 27 * POSSIBILITY OF SUCH DAMAGE. 28 */ 29 30 struct ac97_codec_if; 31 32 /* 33 * This is the interface used to attach the AC97 compliant CODEC. 34 */ 35 enum ac97_host_flags { 36 AC97_HOST_DONT_READ = 0x1, 37 AC97_HOST_DONT_READANY = 0x2, 38 AC97_HOST_SWAPPED_CHANNELS = 0x4, 39 AC97_HOST_ALC650_PIN47_IS_EAPD = 0x8, 40 AC97_HOST_VT1616_DYNEX = 0x10 41 }; 42 43 struct ac97_host_if { 44 void *arg; 45 46 int (*attach)(void *arg, struct ac97_codec_if *codecif); 47 int (*read)(void *arg, u_int8_t reg, u_int16_t *val); 48 int (*write)(void *arg, u_int8_t reg, u_int16_t val); 49 void (*reset)(void *arg); 50 51 enum ac97_host_flags (*flags)(void *arg); 52 void (*spdif_event)(void *arg, int); 53 }; 54 55 /* 56 * This is the interface exported by the AC97 compliant CODEC 57 */ 58 59 struct ac97_codec_if_vtbl { 60 int (*mixer_get_port)(struct ac97_codec_if *addr, mixer_ctrl_t *cp); 61 int (*mixer_set_port)(struct ac97_codec_if *addr, mixer_ctrl_t *cp); 62 int (*query_devinfo)(struct ac97_codec_if *addr, mixer_devinfo_t *cp); 63 int (*get_portnum_by_name)(struct ac97_codec_if *addr, char *class, 64 char *device, char *qualifier); 65 u_int16_t (*get_caps)(struct ac97_codec_if *codec_if); 66 int (*set_rate)(struct ac97_codec_if *codec_if, int target, 67 u_long *rate); 68 void (*set_clock)(struct ac97_codec_if *codec_if, 69 unsigned int clock); 70 void (*lock)(struct ac97_codec_if *codec_if); 71 void (*unlock)(struct ac97_codec_if *codec_if); 72 }; 73 74 struct ac97_codec_if { 75 struct ac97_softc *as; 76 void (*initfunc)(struct ac97_softc *, int); 77 struct ac97_codec_if_vtbl *vtbl; 78 }; 79 80 int ac97_attach(struct ac97_host_if *); 81 int ac97_resume(struct ac97_host_if *, struct ac97_codec_if *); 82 int ac97_set_rate(struct ac97_codec_if *, int, u_long *); 83 84 #define AC97_REG_RESET 0x00 85 #define AC97_CAPS_MICIN 0x0001 86 #define AC97_CAPS_TONECTRL 0x0004 87 #define AC97_CAPS_SIMSTEREO 0x0008 88 #define AC97_CAPS_HEADPHONES 0x0010 89 #define AC97_CAPS_LOUDNESS 0x0020 90 #define AC97_CAPS_DAC18 0x0040 91 #define AC97_CAPS_DAC20 0x0080 92 #define AC97_CAPS_ADC18 0x0100 93 #define AC97_CAPS_ADC20 0x0200 94 #define AC97_CAPS_ENHANCEMENT_MASK 0xfc00 95 #define AC97_CAPS_ENHANCEMENT_SHIFT 10 96 #define AC97_CAPS_ENHANCEMENT(reg) (((reg) >> 10) & 0x1f) 97 #define AC97_REG_MASTER_VOLUME 0x02 98 #define AC97_REG_HEADPHONE_VOLUME 0x04 99 #define AC97_REG_MASTER_VOLUME_MONO 0x06 100 #define AC97_REG_MASTER_TONE 0x08 101 #define AC97_REG_PCBEEP_VOLUME 0x0a 102 #define AC97_REG_PHONE_VOLUME 0x0c 103 #define AC97_REG_MIC_VOLUME 0x0e 104 #define AC97_REG_LINEIN_VOLUME 0x10 105 #define AC97_REG_CD_VOLUME 0x12 106 #define AC97_REG_VIDEO_VOLUME 0x14 107 #define AC97_REG_AUX_VOLUME 0x16 108 #define AC97_REG_PCMOUT_VOLUME 0x18 109 #define AC97_REG_RECORD_SELECT 0x1a 110 #define AC97_REG_RECORD_GAIN 0x1c 111 #define AC97_REG_RECORD_GAIN_MIC 0x1e 112 #define AC97_REG_GP 0x20 113 #define AC97_REG_3D_CONTROL 0x22 114 #define AC97_REG_MODEM_SAMPLE_RATE 0x24 115 #define AC97_REG_POWER 0x26 116 #define AC97_POWER_ADC 0x0001 117 #define AC97_POWER_DAC 0x0002 118 #define AC97_POWER_ANL 0x0004 119 #define AC97_POWER_REF 0x0008 120 #define AC97_POWER_IN 0x0100 121 #define AC97_POWER_OUT 0x0200 122 #define AC97_POWER_MIXER 0x0400 123 #define AC97_POWER_MIXER_VREF 0x0800 124 #define AC97_POWER_ACLINK 0x1000 125 #define AC97_POWER_CLK 0x2000 126 #define AC97_POWER_AUX 0x4000 127 #define AC97_POWER_EAMP 0x8000 128 /* Extended Audio Register Set */ 129 #define AC97_REG_EXT_AUDIO_ID 0x28 130 #define AC97_REG_EXT_AUDIO_CTRL 0x2a 131 #define AC97_EXT_AUDIO_VRA 0x0001 132 #define AC97_EXT_AUDIO_DRA 0x0002 133 #define AC97_EXT_AUDIO_SPDIF 0x0004 134 #define AC97_EXT_AUDIO_VRM 0x0008 135 #define AC97_EXT_AUDIO_DSA_MASK 0x0030 136 #define AC97_EXT_AUDIO_DSA00 0x0000 137 #define AC97_EXT_AUDIO_DSA01 0x0010 138 #define AC97_EXT_AUDIO_DSA10 0x0020 139 #define AC97_EXT_AUDIO_DSA11 0x0030 140 #define AC97_EXT_AUDIO_SPSA_MASK 0x0030 141 #define AC97_EXT_AUDIO_SPSA34 0x0000 142 #define AC97_EXT_AUDIO_SPSA78 0x0010 143 #define AC97_EXT_AUDIO_SPSA69 0x0020 144 #define AC97_EXT_AUDIO_SPSAAB 0x0030 145 #define AC97_EXT_AUDIO_CDAC 0x0040 146 #define AC97_EXT_AUDIO_SDAC 0x0080 147 #define AC97_EXT_AUDIO_LDAC 0x0100 148 #define AC97_EXT_AUDIO_AMAP 0x0200 149 #define AC97_EXT_AUDIO_SPCV 0x0400 150 #define AC97_EXT_AUDIO_REV_11 0x0000 151 #define AC97_EXT_AUDIO_REV_22 0x0400 152 #define AC97_EXT_AUDIO_REV_23 0x0800 153 #define AC97_EXT_AUDIO_REV_MASK 0x0c00 154 #define AC97_EXT_AUDIO_ID 0xc000 155 #define AC97_EXT_AUDIO_BITS "\020\01vra\02dra\03spdif\04vrm\05dsa0\06dsa1\07cdac\010sdac\011ldac\012amap\013rev0\014rev1\017id0\020id1" 156 #define AC97_SINGLE_RATE 48000 157 #define AC97_REG_PCM_FRONT_DAC_RATE 0x2c 158 #define AC97_REG_PCM_SURR_DAC_RATE 0x2e 159 #define AC97_REG_PCM_LFE_DAC_RATE 0x30 160 #define AC97_REG_PCM_LR_ADC_RATE 0x32 161 #define AC97_REG_PCM_MIC_ADC_RATE 0x34 162 #define AC97_REG_CENTER_LFE_MASTER 0x36 163 #define AC97_REG_SURR_MASTER 0x38 164 #define AC97_REG_SPDIF_CTRL 0x3a 165 #define AC97_REG_SPDIF_CTRL_BITS "\02\01pro\02/audio\03copy\04pre\014l\017drs\020valid" 166 #define AC97_SPDIF_V 0x8000 167 #define AC97_SPDIF_DRS 0x4000 168 #define AC97_SPDIF_SPSR_MASK 0x3000 169 #define AC97_SPDIF_SPSR_44K 0x0000 170 #define AC97_SPDIF_SPSR_48K 0x2000 171 #define AC97_SPDIF_SPSR_32K 0x1000 172 #define AC97_SPDIF_L 0x0800 173 #define AC97_SPDIF_CC_MASK 0x07f0 174 #define AC97_SPDIF_PRE 0x0008 175 #define AC97_SPDIF_COPY 0x0004 176 #define AC97_SPDIF_NOAUDIO 0x0002 177 #define AC97_SPDIF_PRO 0x0001 178 179 #define AC97_REG_VENDOR_ID1 0x7c 180 #define AC97_REG_VENDOR_ID2 0x7e 181 #define AC97_VENDOR_ID_MASK 0xffffff00 182 183 184 /* Analog Devices codec specific data */ 185 #define AC97_AD_REG_MISC 0x76 186 #define AC97_AD_MISC_MBG0 0x0001 /* 0 */ 187 #define AC97_AD_MISC_MBG1 0x0002 /* 1 */ 188 #define AC97_AD_MISC_VREFD 0x0004 /* 2 */ 189 #define AC97_AD_MISC_VREFH 0x0008 /* 3 */ 190 #define AC97_AD_MISC_SRU 0x0010 /* 4 */ 191 #define AC97_AD_MISC_LOSEL 0x0020 /* 5 */ 192 #define AC97_AD_MISC_2CMIC 0x0040 /* 6 */ 193 #define AC97_AD_MISC_SPRD 0x0080 /* 7 */ 194 #define AC97_AD_MISC_DMIX0 0x0100 /* 8 */ 195 #define AC97_AD_MISC_DMIX1 0x0200 /* 9 */ 196 #define AC97_AD_MISC_HPSEL 0x0400 /*10 */ 197 #define AC97_AD_MISC_CLDIS 0x0800 /*11 */ 198 #define AC97_AD_MISC_LODIS 0x1000 /*12 */ 199 #define AC97_AD_MISC_MSPLT 0x2000 /*13 */ 200 #define AC97_AD_MISC_AC97NC 0x4000 /*14 */ 201 #define AC97_AD_MISC_DACZ 0x8000 /*15 */ 202 203 /* Avance Logic codec specific data*/ 204 #define AC97_ALC650_REG_MULTI_CHANNEL_CONTROL 0x6a 205 #define AC97_ALC650_MCC_SLOT_MODIFY_MASK 0xc000 206 #define AC97_ALC650_MCC_FRONTDAC_FROM_SPDIFIN 0x2000 207 #define AC97_ALC650_MCC_SPDIFOUT_FROM_ADC 0x1000 208 #define AC97_ALC650_MCC_PCM_FROM_SPDIFIN 0x0800 209 #define AC97_ALC650_MCC_MIC_OR_CENTERLFE 0x0400 210 #define AC97_ALC650_MCC_LINEIN_OR_SURROUND 0x0200 211 #define AC97_ALC650_MCC_INDEPENDENT_MASTER_L 0x0080 212 #define AC97_ALC650_MCC_INDEPENDENT_MASTER_R 0x0040 213 #define AC97_ALC650_MCC_ANALOG_TO_CENTERLFE 0x0020 214 #define AC97_ALC650_MCC_ANALOG_TO_SURROUND 0x0010 215 #define AC97_ALC650_MCC_EXCHANGE_CENTERLFE 0x0008 216 #define AC97_ALC650_MCC_CENTERLFE_DOWNMIX 0x0004 217 #define AC97_ALC650_MCC_SURROUND_DOWNMIX 0x0002 218 #define AC97_ALC650_MCC_LINEOUT_TO_SURROUND 0x0001 219 #define AC97_ALC650_REG_MISC 0x7a 220 #define AC97_ALC650_MISC_PIN47 0x0002 221 #define AC97_ALC650_MISC_VREFDIS 0x1000 222 223 224 /* Conexant codec specific data */ 225 #define AC97_CX_REG_MISC 0x5c 226 #define AC97_CX_PCM 0x00 227 #define AC97_CX_AC3 0x02 228 #define AC97_CX_MASK 0x03 229 #define AC97_CX_COPYRIGHT 0x04 230 #define AC97_CX_SPDIFEN 0x08 231 232 233 /* VIA codec specific data */ 234 #define AC97_VT_REG_TEST 0x5a 235 #define AC97_VT_LVL 0x8000 /* hp controls rear */ 236 #define AC97_VT_LCTF 0x1000 /* lfe/center to front downmix */ 237 #define AC97_VT_STF 0x0800 /* surround to front downmix */ 238 #define AC97_VT_BPDC 0x0400 /* enable DC-offset cancellation */ 239 #define AC97_VT_DC 0x0200 /* DC offset cancellation capable */ 240 241 #define AC97_IS_FIXED_RATE(codec) !((codec)->vtbl->get_caps(codec) & \ 242 AC97_EXT_AUDIO_VRA) 243 #define AC97_BITS_6CH (AC97_EXT_AUDIO_SDAC | AC97_EXT_AUDIO_CDAC | \ 244 AC97_EXT_AUDIO_LDAC) 245