sound/pci/hda/hda_local.h

   1 /*
   2  * Universal Interface for Intel High Definition Audio Codec
   3  *
   4  * Local helper functions
   5  *
   6  * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
   7  *
   8  *  This program is free software; you can redistribute it and/or modify it
   9  *  under the terms of the GNU General Public License as published by the Free
  10  *  Software Foundation; either version 2 of the License, or (at your option)
  11  *  any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful, but WITHOUT
  14  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15  *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  16  *  more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License along with
  19  *  this program; if not, write to the Free Software Foundation, Inc., 59
  20  *  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21  */
  22
  23 #ifndef __SOUND_HDA_LOCAL_H
  24 #define __SOUND_HDA_LOCAL_H
  25
  26 /*
  27  * for mixer controls
  28  */
  29 #define HDA_COMPOSE_AMP_VAL(nid,chs,idx,dir) ((nid) | ((chs)<<16) | ((dir)<<18) | ((idx)<<19))
  30 /* mono volume with index (index=0,1,...) (channel=1,2) */
  31 #define HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
  32         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx,  \
  33           .info = snd_hda_mixer_amp_volume_info, \
  34           .get = snd_hda_mixer_amp_volume_get, \
  35           .put = snd_hda_mixer_amp_volume_put, \
  36           .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
  37 /* stereo volume with index */
  38 #define HDA_CODEC_VOLUME_IDX(xname, xcidx, nid, xindex, direction) \
  39         HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
  40 /* mono volume */
  41 #define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) \
  42         HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, channel, xindex, direction)
  43 /* stereo volume */
  44 #define HDA_CODEC_VOLUME(xname, nid, xindex, direction) \
  45         HDA_CODEC_VOLUME_MONO(xname, nid, 3, xindex, direction)
  46 /* mono mute switch with index (index=0,1,...) (channel=1,2) */
  47 #define HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
  48         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
  49           .info = snd_hda_mixer_amp_switch_info, \
  50           .get = snd_hda_mixer_amp_switch_get, \
  51           .put = snd_hda_mixer_amp_switch_put, \
  52           .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
  53 /* stereo mute switch with index */
  54 #define HDA_CODEC_MUTE_IDX(xname, xcidx, nid, xindex, direction) \
  55         HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
  56 /* mono mute switch */
  57 #define HDA_CODEC_MUTE_MONO(xname, nid, channel, xindex, direction) \
  58         HDA_CODEC_MUTE_MONO_IDX(xname, 0, nid, channel, xindex, direction)
  59 /* stereo mute switch */
  60 #define HDA_CODEC_MUTE(xname, nid, xindex, direction) \
  61         HDA_CODEC_MUTE_MONO(xname, nid, 3, xindex, direction)
  62
  63 int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo);
  64 int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
  65 int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
  66 int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo);
  67 int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
  68 int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
  69 /* lowlevel accessor with caching; use carefully */
  70 int snd_hda_codec_amp_read(struct hda_codec *codec, hda_nid_t nid, int ch,
  71                            int direction, int index);
  72 int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch,
  73                              int direction, int idx, int mask, int val);
  74
  75 /* mono switch binding multiple inputs */
  76 #define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
  77         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0,  \
  78           .info = snd_hda_mixer_amp_switch_info, \
  79           .get = snd_hda_mixer_bind_switch_get, \
  80           .put = snd_hda_mixer_bind_switch_put, \
  81           .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }
  82
  83 /* stereo switch binding multiple inputs */
  84 #define HDA_BIND_MUTE(xname,nid,indices,dir) HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
  85
  86 int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
  87 int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
  88
  89 int snd_hda_create_spdif_out_ctls(struct hda_codec *codec, hda_nid_t nid);
  90 int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
  91
  92 /*
  93  * input MUX helper
  94  */
  95 #define HDA_MAX_NUM_INPUTS      16
  96 struct hda_input_mux_item {
  97         const char *label;
  98         unsigned int index;
  99 };
 100 struct hda_input_mux {
 101         unsigned int num_items;
 102         struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
 103 };
 104
 105 int snd_hda_input_mux_info(const struct hda_input_mux *imux, struct snd_ctl_elem_info *uinfo);
 106 int snd_hda_input_mux_put(struct hda_codec *codec, const struct hda_input_mux *imux,
 107                           struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
 108                           unsigned int *cur_val);
 109
 110 /*
 111  * Channel mode helper
 112  */
 113 struct hda_channel_mode {
 114         int channels;
 115         const struct hda_verb *sequence;
 116 };
 117
 118 int snd_hda_ch_mode_info(struct hda_codec *codec, struct snd_ctl_elem_info *uinfo,
 119                          const struct hda_channel_mode *chmode, int num_chmodes);
 120 int snd_hda_ch_mode_get(struct hda_codec *codec, struct snd_ctl_elem_value *ucontrol,
 121                         const struct hda_channel_mode *chmode, int num_chmodes,
 122                         int max_channels);
 123 int snd_hda_ch_mode_put(struct hda_codec *codec, struct snd_ctl_elem_value *ucontrol,
 124                         const struct hda_channel_mode *chmode, int num_chmodes,
 125                         int *max_channelsp);
 126
 127 /*
 128  * Multi-channel / digital-out PCM helper
 129  */
 130
 131 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
 132 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
 133
 134 struct hda_multi_out {
 135         int num_dacs;           /* # of DACs, must be more than 1 */
 136         hda_nid_t *dac_nids;    /* DAC list */
 137         hda_nid_t hp_nid;       /* optional DAC for HP, 0 when not exists */
 138         hda_nid_t extra_out_nid[3];     /* optional DACs, 0 when not exists */
 139         hda_nid_t dig_out_nid;  /* digital out audio widget */
 140         int max_channels;       /* currently supported analog channels */
 141         int dig_out_used;       /* current usage of digital out (HDA_DIG_XXX) */
 142 };
 143
 144 int snd_hda_multi_out_dig_open(struct hda_codec *codec, struct hda_multi_out *mout);
 145 int snd_hda_multi_out_dig_close(struct hda_codec *codec, struct hda_multi_out *mout);
 146 int snd_hda_multi_out_analog_open(struct hda_codec *codec, struct hda_multi_out *mout,
 147                                   struct snd_pcm_substream *substream);
 148 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec, struct hda_multi_out *mout,
 149                                      unsigned int stream_tag,
 150                                      unsigned int format,
 151                                      struct snd_pcm_substream *substream);
 152 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec, struct hda_multi_out *mout);
 153
 154 /*
 155  * generic codec parser
 156  */
 157 int snd_hda_parse_generic_codec(struct hda_codec *codec);
 158
 159 /*
 160  * generic proc interface
 161  */
 162 #ifdef CONFIG_PROC_FS
 163 int snd_hda_codec_proc_new(struct hda_codec *codec);
 164 #else
 165 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
 166 #endif
 167
 168 /*
 169  * Misc
 170  */
 171 struct hda_board_config {
 172         const char *modelname;
 173         int config;
 174         unsigned short pci_subvendor;
 175         unsigned short pci_subdevice;
 176 };
 177
 178 int snd_hda_check_board_config(struct hda_codec *codec, const struct hda_board_config *tbl);
 179 int snd_hda_add_new_ctls(struct hda_codec *codec, struct snd_kcontrol_new *knew);
 180
 181 /*
 182  * power management
 183  */
 184 #ifdef CONFIG_PM
 185 int snd_hda_resume_ctls(struct hda_codec *codec, struct snd_kcontrol_new *knew);
 186 int snd_hda_resume_spdif_out(struct hda_codec *codec);
 187 int snd_hda_resume_spdif_in(struct hda_codec *codec);
 188 #endif
 189
 190 /*
 191  * unsolicited event handler
 192  */
 193
 194 #define HDA_UNSOL_QUEUE_SIZE    64
 195
 196 struct hda_bus_unsolicited {
 197         /* ring buffer */
 198         u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
 199         unsigned int rp, wp;
 200
 201         /* workqueue */
 202         struct workqueue_struct *workq;
 203         struct work_struct work;
 204 };
 205
 206 /*
 207  * Helper for automatic ping configuration
 208  */
 209
 210 enum {
 211         AUTO_PIN_MIC,
 212         AUTO_PIN_FRONT_MIC,
 213         AUTO_PIN_LINE,
 214         AUTO_PIN_FRONT_LINE,
 215         AUTO_PIN_CD,
 216         AUTO_PIN_AUX,
 217         AUTO_PIN_LAST
 218 };
 219
 220 extern const char *auto_pin_cfg_labels[AUTO_PIN_LAST];
 221
 222 struct auto_pin_cfg {
 223         int line_outs;
 224         hda_nid_t line_out_pins[5]; /* sorted in the order of Front/Surr/CLFE/Side */
 225         int speaker_outs;
 226         hda_nid_t speaker_pins[5];
 227         hda_nid_t hp_pin;
 228         hda_nid_t input_pins[AUTO_PIN_LAST];
 229         hda_nid_t dig_out_pin;
 230         hda_nid_t dig_in_pin;
 231 };
 232
 233 #define get_defcfg_connect(cfg) ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
 234 #define get_defcfg_association(cfg) ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
 235 #define get_defcfg_location(cfg) ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
 236 #define get_defcfg_sequence(cfg) (cfg & AC_DEFCFG_SEQUENCE)
 237 #define get_defcfg_device(cfg) ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
 238
 239 int snd_hda_parse_pin_def_config(struct hda_codec *codec, struct auto_pin_cfg *cfg,
 240                                  hda_nid_t *ignore_nids);
 241
 242 /* amp values */
 243 #define AMP_IN_MUTE(idx)        (0x7080 | ((idx)<<8))
 244 #define AMP_IN_UNMUTE(idx)      (0x7000 | ((idx)<<8))
 245 #define AMP_OUT_MUTE    0xb080
 246 #define AMP_OUT_UNMUTE  0xb000
 247 #define AMP_OUT_ZERO    0xb000
 248 /* pinctl values */
 249 #define PIN_IN          0x20
 250 #define PIN_VREF80      0x24
 251 #define PIN_VREF50      0x21
 252 #define PIN_OUT         0x40
 253 #define PIN_HP          0xc0
 254 #define PIN_HP_AMP      0x80
 255
 256 /*
 257  * get widget capabilities
 258  */
 259 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
 260 {
 261         if (nid < codec->start_nid ||
 262             nid >= codec->start_nid + codec->num_nodes)
 263                 return snd_hda_param_read(codec, nid, AC_PAR_AUDIO_WIDGET_CAP);
 264         return codec->wcaps[nid - codec->start_nid];
 265 }
 266
 267
 268 #endif /* __SOUND_HDA_LOCAL_H */