sys/gnu/dev/sound/pci/emu10k1-ac97.h

   1 /* $FreeBSD: src/sys/gnu/dev/sound/pci/emu10k1-ac97.h,v 1.2 2004/01/09 05:08:32 obrien Exp $ */
   2
   3 #ifndef _AC97_CODEC_H_
   4 #define _AC97_CODEC_H_
   5
   6 #ifdef __linux__
   7 #include <linux/types.h>
   8 #include <linux/soundcard.h>
   9 #endif
  10
  11 /* AC97 1.0 */
  12 #define  AC97_RESET               0x0000      //
  13 #define  AC97_MASTER_VOL_STEREO   0x0002      // Line Out
  14 #define  AC97_HEADPHONE_VOL       0x0004      //
  15 #define  AC97_MASTER_VOL_MONO     0x0006      // TAD Output
  16 #define  AC97_MASTER_TONE         0x0008      //
  17 #define  AC97_PCBEEP_VOL          0x000a      // none
  18 #define  AC97_PHONE_VOL           0x000c      // TAD Input (mono)
  19 #define  AC97_MIC_VOL             0x000e      // MIC Input (mono)
  20 #define  AC97_LINEIN_VOL          0x0010      // Line Input (stereo)
  21 #define  AC97_CD_VOL              0x0012      // CD Input (stereo)
  22 #define  AC97_VIDEO_VOL           0x0014      // none
  23 #define  AC97_AUX_VOL             0x0016      // Aux Input (stereo)
  24 #define  AC97_PCMOUT_VOL          0x0018      // Wave Output (stereo)
  25 #define  AC97_RECORD_SELECT       0x001a      //
  26 #define  AC97_RECORD_GAIN         0x001c
  27 #define  AC97_RECORD_GAIN_MIC     0x001e
  28 #define  AC97_GENERAL_PURPOSE     0x0020
  29 #define  AC97_3D_CONTROL          0x0022
  30 #define  AC97_MODEM_RATE          0x0024
  31 #define  AC97_POWER_CONTROL       0x0026
  32
  33 /* AC'97 2.0 */
  34 #define AC97_EXTENDED_ID          0x0028       /* Extended Audio ID */
  35 #define AC97_EXTENDED_STATUS      0x002A       /* Extended Audio Status */
  36 #define AC97_PCM_FRONT_DAC_RATE   0x002C       /* PCM Front DAC Rate */
  37 #define AC97_PCM_SURR_DAC_RATE    0x002E       /* PCM Surround DAC Rate */
  38 #define AC97_PCM_LFE_DAC_RATE     0x0030       /* PCM LFE DAC Rate */
  39 #define AC97_PCM_LR_ADC_RATE      0x0032       /* PCM LR ADC Rate */
  40 #define AC97_PCM_MIC_ADC_RATE     0x0034       /* PCM MIC ADC Rate */
  41 #define AC97_CENTER_LFE_MASTER    0x0036       /* Center + LFE Master Volume */
  42 #define AC97_SURROUND_MASTER      0x0038       /* Surround (Rear) Master Volume */
  43 #define AC97_RESERVED_3A          0x003A       /* Reserved in AC '97 < 2.2 */
  44
  45 /* AC'97 2.2 */
  46 #define AC97_SPDIF_CONTROL        0x003A       /* S/PDIF Control */
  47
  48 /* range 0x3c-0x58 - MODEM */
  49 #define AC97_EXTENDED_MODEM_ID    0x003C
  50 #define AC97_EXTEND_MODEM_STAT    0x003E
  51 #define AC97_LINE1_RATE           0x0040
  52 #define AC97_LINE2_RATE           0x0042
  53 #define AC97_HANDSET_RATE         0x0044
  54 #define AC97_LINE1_LEVEL          0x0046
  55 #define AC97_LINE2_LEVEL          0x0048
  56 #define AC97_HANDSET_LEVEL        0x004A
  57 #define AC97_GPIO_CONFIG          0x004C
  58 #define AC97_GPIO_POLARITY        0x004E
  59 #define AC97_GPIO_STICKY          0x0050
  60 #define AC97_GPIO_WAKE_UP         0x0052
  61 #define AC97_GPIO_STATUS          0x0054
  62 #define AC97_MISC_MODEM_STAT      0x0056
  63 #define AC97_RESERVED_58          0x0058
  64
  65 /* registers 0x005a - 0x007a are vendor reserved */
  66
  67 #define AC97_VENDOR_ID1           0x007c
  68 #define AC97_VENDOR_ID2           0x007e
  69
  70 /* volume control bit defines */
  71 #ifndef AC97_MUTE
  72 #define AC97_MUTE                 0x8000
  73 #endif
  74 #define AC97_MICBOOST             0x0040
  75 #define AC97_LEFTVOL              0x3f00
  76 #define AC97_RIGHTVOL             0x003f
  77
  78 /* record mux defines */
  79 #define AC97_RECMUX_MIC           0x0000
  80 #define AC97_RECMUX_CD            0x0101
  81 #define AC97_RECMUX_VIDEO         0x0202
  82 #define AC97_RECMUX_AUX           0x0303
  83 #define AC97_RECMUX_LINE          0x0404
  84 #define AC97_RECMUX_STEREO_MIX    0x0505
  85 #define AC97_RECMUX_MONO_MIX      0x0606
  86 #define AC97_RECMUX_PHONE         0x0707
  87
  88 /* general purpose register bit defines */
  89 #define AC97_GP_LPBK              0x0080       /* Loopback mode */
  90 #define AC97_GP_MS                0x0100       /* Mic Select 0=Mic1, 1=Mic2 */
  91 #define AC97_GP_MIX               0x0200       /* Mono output select 0=Mix, 1=Mic */
  92 #define AC97_GP_RLBK              0x0400       /* Remote Loopback - Modem line codec */
  93 #define AC97_GP_LLBK              0x0800       /* Local Loopback - Modem Line codec */
  94 #define AC97_GP_LD                0x1000       /* Loudness 1=on */
  95 #define AC97_GP_3D                0x2000       /* 3D Enhancement 1=on */
  96 #define AC97_GP_ST                0x4000       /* Stereo Enhancement 1=on */
  97 #define AC97_GP_POP               0x8000       /* Pcm Out Path, 0=pre 3D, 1=post 3D */
  98
  99 /* extended audio status and control bit defines */
 100 #define AC97_EA_VRA               0x0001       /* Variable bit rate enable bit */
 101 #define AC97_EA_DRA               0x0002       /* Double-rate audio enable bit */
 102 #define AC97_EA_SPDIF             0x0004       /* S/PDIF Enable bit */
 103 #define AC97_EA_VRM               0x0008       /* Variable bit rate for MIC enable bit */
 104 #define AC97_EA_CDAC              0x0040       /* PCM Center DAC is ready (Read only) */
 105 #define AC97_EA_SDAC              0x0040       /* PCM Surround DACs are ready (Read only) */
 106 #define AC97_EA_LDAC              0x0080       /* PCM LFE DAC is ready (Read only) */
 107 #define AC97_EA_MDAC              0x0100       /* MIC ADC is ready (Read only) */
 108 #define AC97_EA_SPCV              0x0400       /* S/PDIF configuration valid (Read only) */
 109 #define AC97_EA_PRI               0x0800       /* Turns the PCM Center DAC off */
 110 #define AC97_EA_PRJ               0x1000       /* Turns the PCM Surround DACs off */
 111 #define AC97_EA_PRK               0x2000       /* Turns the PCM LFE DAC off */
 112 #define AC97_EA_PRL               0x4000       /* Turns the MIC ADC off */
 113 #define AC97_EA_SLOT_MASK         0xffcf       /* Mask for slot assignment bits */
 114 #define AC97_EA_SPSA_3_4          0x0000       /* Slot assigned to 3 & 4 */
 115 #define AC97_EA_SPSA_7_8          0x0010       /* Slot assigned to 7 & 8 */
 116 #define AC97_EA_SPSA_6_9          0x0020       /* Slot assigned to 6 & 9 */
 117 #define AC97_EA_SPSA_10_11        0x0030       /* Slot assigned to 10 & 11 */
 118
 119 /* S/PDIF control bit defines */
 120 #define AC97_SC_PRO               0x0001       /* Professional status */
 121 #define AC97_SC_NAUDIO            0x0002       /* Non audio stream */
 122 #define AC97_SC_COPY              0x0004       /* Copyright status */
 123 #define AC97_SC_PRE               0x0008       /* Preemphasis status */
 124 #define AC97_SC_CC_MASK           0x07f0       /* Category Code mask */
 125 #define AC97_SC_L                 0x0800       /* Generation Level status */
 126 #define AC97_SC_SPSR_MASK         0xcfff       /* S/PDIF Sample Rate bits */
 127 #define AC97_SC_SPSR_44K          0x0000       /* Use 44.1kHz Sample rate */
 128 #define AC97_SC_SPSR_48K          0x2000       /* Use 48kHz Sample rate */
 129 #define AC97_SC_SPSR_32K          0x3000       /* Use 32kHz Sample rate */
 130 #define AC97_SC_DRS               0x4000       /* Double Rate S/PDIF */
 131 #define AC97_SC_V                 0x8000       /* Validity status */
 132
 133 /* powerdown control and status bit defines */
 134
 135 /* status */
 136 #define AC97_PWR_MDM              0x0010       /* Modem section ready */
 137 #define AC97_PWR_REF              0x0008       /* Vref nominal */
 138 #define AC97_PWR_ANL              0x0004       /* Analog section ready */
 139 #define AC97_PWR_DAC              0x0002       /* DAC section ready */
 140 #define AC97_PWR_ADC              0x0001       /* ADC section ready */
 141
 142 /* control */
 143 #define AC97_PWR_PR0              0x0100       /* ADC and Mux powerdown */
 144 #define AC97_PWR_PR1              0x0200       /* DAC powerdown */
 145 #define AC97_PWR_PR2              0x0400       /* Output mixer powerdown (Vref on) */
 146 #define AC97_PWR_PR3              0x0800       /* Output mixer powerdown (Vref off) */
 147 #define AC97_PWR_PR4              0x1000       /* AC-link powerdown */
 148 #define AC97_PWR_PR5              0x2000       /* Internal Clk disable */
 149 #define AC97_PWR_PR6              0x4000       /* HP amp powerdown */
 150 #define AC97_PWR_PR7              0x8000       /* Modem off - if supported */
 151
 152 /* extended audio ID register bit defines */
 153 #define AC97_EXTID_VRA            0x0001
 154 #define AC97_EXTID_DRA            0x0002
 155 #define AC97_EXTID_SPDIF          0x0004
 156 #define AC97_EXTID_VRM            0x0008
 157 #define AC97_EXTID_DSA0           0x0010
 158 #define AC97_EXTID_DSA1           0x0020
 159 #define AC97_EXTID_CDAC           0x0040
 160 #define AC97_EXTID_SDAC           0x0080
 161 #define AC97_EXTID_LDAC           0x0100
 162 #define AC97_EXTID_AMAP           0x0200
 163 #define AC97_EXTID_REV0           0x0400
 164 #define AC97_EXTID_REV1           0x0800
 165 #define AC97_EXTID_ID0            0x4000
 166 #define AC97_EXTID_ID1            0x8000
 167
 168 /* extended status register bit defines */
 169 #define AC97_EXTSTAT_VRA          0x0001
 170 #define AC97_EXTSTAT_DRA          0x0002
 171 #define AC97_EXTSTAT_SPDIF        0x0004
 172 #define AC97_EXTSTAT_VRM          0x0008
 173 #define AC97_EXTSTAT_SPSA0        0x0010
 174 #define AC97_EXTSTAT_SPSA1        0x0020
 175 #define AC97_EXTSTAT_CDAC         0x0040
 176 #define AC97_EXTSTAT_SDAC         0x0080
 177 #define AC97_EXTSTAT_LDAC         0x0100
 178 #define AC97_EXTSTAT_MADC         0x0200
 179 #define AC97_EXTSTAT_SPCV         0x0400
 180 #define AC97_EXTSTAT_PRI          0x0800
 181 #define AC97_EXTSTAT_PRJ          0x1000
 182 #define AC97_EXTSTAT_PRK          0x2000
 183 #define AC97_EXTSTAT_PRL          0x4000
 184
 185 /* useful power states */
 186 #define AC97_PWR_D0               0x0000      /* everything on */
 187 #define AC97_PWR_D1              AC97_PWR_PR0|AC97_PWR_PR1|AC97_PWR_PR4
 188 #define AC97_PWR_D2              AC97_PWR_PR0|AC97_PWR_PR1|AC97_PWR_PR2|AC97_PWR_PR3|AC97_PWR_PR4
 189 #define AC97_PWR_D3              AC97_PWR_PR0|AC97_PWR_PR1|AC97_PWR_PR2|AC97_PWR_PR3|AC97_PWR_PR4
 190 #define AC97_PWR_ANLOFF          AC97_PWR_PR2|AC97_PWR_PR3  /* analog section off */
 191
 192 /* Total number of defined registers.  */
 193 #define AC97_REG_CNT 64
 194
 195
 196 /* OSS interface to the ac97s.. */
 197 #define AC97_STEREO_MASK (SOUND_MASK_VOLUME|SOUND_MASK_PCM|\
 198         SOUND_MASK_LINE|SOUND_MASK_CD|\
 199         SOUND_MASK_ALTPCM|SOUND_MASK_IGAIN|\
 200         SOUND_MASK_LINE1|SOUND_MASK_VIDEO)
 201
 202 #define AC97_SUPPORTED_MASK (AC97_STEREO_MASK | \
 203         SOUND_MASK_BASS|SOUND_MASK_TREBLE|\
 204         SOUND_MASK_SPEAKER|SOUND_MASK_MIC|\
 205         SOUND_MASK_PHONEIN|SOUND_MASK_PHONEOUT)
 206
 207 #define AC97_RECORD_MASK (SOUND_MASK_MIC|\
 208         SOUND_MASK_CD|SOUND_MASK_IGAIN|SOUND_MASK_VIDEO|\
 209         SOUND_MASK_LINE1| SOUND_MASK_LINE|\
 210         SOUND_MASK_PHONEIN)
 211
 212 /* original check is not good enough in case FOO is greater than
 213  * SOUND_MIXER_NRDEVICES because the supported_mixers has exactly
 214  * SOUND_MIXER_NRDEVICES elements.
 215  * before matching the given mixer against the bitmask in supported_mixers we
 216  * check if mixer number exceeds maximum allowed size which is as mentioned
 217  * above SOUND_MIXER_NRDEVICES */
 218 #define supported_mixer(CODEC,FOO) ((FOO >= 0) && \
 219                                     (FOO < SOUND_MIXER_NRDEVICES) && \
 220                                     (CODEC)->supported_mixers & (1<<FOO) )
 221
 222 #ifdef __linux__
 223 struct ac97_codec {
 224         /* AC97 controller connected with */
 225         void *private_data;
 226
 227         char *name;
 228         int id;
 229         int dev_mixer;
 230         int type;
 231
 232         int modem:1;
 233
 234         struct ac97_ops *codec_ops;
 235
 236         /* controller specific lower leverl ac97 accessing routines */
 237         u16  (*codec_read)  (struct ac97_codec *codec, u8 reg);
 238         void (*codec_write) (struct ac97_codec *codec, u8 reg, u16 val);
 239
 240         /* Wait for codec-ready.  Ok to sleep here.  */
 241         void  (*codec_wait)  (struct ac97_codec *codec);
 242
 243         /* OSS mixer masks */
 244         int modcnt;
 245         int supported_mixers;
 246         int stereo_mixers;
 247         int record_sources;
 248
 249         /* Property flags */
 250         int flags;
 251
 252         int bit_resolution;
 253
 254         /* OSS mixer interface */
 255         int  (*read_mixer) (struct ac97_codec *codec, int oss_channel);
 256         void (*write_mixer)(struct ac97_codec *codec, int oss_channel,
 257                             unsigned int left, unsigned int right);
 258         int  (*recmask_io) (struct ac97_codec *codec, int rw, int mask);
 259         int  (*mixer_ioctl)(struct ac97_codec *codec, unsigned int cmd, unsigned long arg);
 260
 261         /* saved OSS mixer states */
 262         unsigned int mixer_state[SOUND_MIXER_NRDEVICES];
 263
 264         /* Software Modem interface */
 265         int  (*modem_ioctl)(struct ac97_codec *codec, unsigned int cmd, unsigned long arg);
 266 };
 267
 268 /*
 269  *      Operation structures for each known AC97 chip
 270  */
 271
 272 struct ac97_ops
 273 {
 274         /* Initialise */
 275         int (*init)(struct ac97_codec *c);
 276         /* Amplifier control */
 277         int (*amplifier)(struct ac97_codec *codec, int on);
 278         /* Digital mode control */
 279         int (*digital)(struct ac97_codec *codec, int format);
 280 #define AC97_DELUDED_MODEM      1       /* Audio codec reports its a modem */
 281 #define AC97_NO_PCM_VOLUME      2       /* Volume control is missing       */
 282 };
 283
 284 extern int ac97_read_proc (char *page_out, char **start, off_t off,
 285                            int count, int *eof, void *data);
 286 extern int ac97_probe_codec(struct ac97_codec *);
 287 extern unsigned int ac97_set_adc_rate(struct ac97_codec *codec, unsigned int rate);
 288 extern unsigned int ac97_set_dac_rate(struct ac97_codec *codec, unsigned int rate);
 289 extern int ac97_save_state(struct ac97_codec *codec);
 290 extern int ac97_restore_state(struct ac97_codec *codec);
 291 #endif  /*__linux__*/
 292
 293 #endif /* _AC97_CODEC_H_ */