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(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t *uinfo);
  64 int snd_hda_mixer_amp_volume_get(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol);
  65 int snd_hda_mixer_amp_volume_put(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol);
  66 int snd_hda_mixer_amp_switch_info(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t *uinfo);
  67 int snd_hda_mixer_amp_switch_get(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol);
  68 int snd_hda_mixer_amp_switch_put(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol);
  69
  70 /* mono switch binding multiple inputs */
  71 #define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
  72         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0,  \
  73           .info = snd_hda_mixer_amp_switch_info, \
  74           .get = snd_hda_mixer_bind_switch_get, \
  75           .put = snd_hda_mixer_bind_switch_put, \
  76           .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }
  77
  78 /* stereo switch binding multiple inputs */
  79 #define HDA_BIND_MUTE(xname,nid,indices,dir) HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
  80
  81 int snd_hda_mixer_bind_switch_get(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol);
  82 int snd_hda_mixer_bind_switch_put(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol);
  83
  84 int snd_hda_create_spdif_out_ctls(struct hda_codec *codec, hda_nid_t nid);
  85 int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
  86
  87 /*
  88  * input MUX helper
  89  */
  90 #define HDA_MAX_NUM_INPUTS      8
  91 struct hda_input_mux_item {
  92         const char *label;
  93         unsigned int index;
  94 };
  95 struct hda_input_mux {
  96         unsigned int num_items;
  97         struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
  98 };
  99
 100 int snd_hda_input_mux_info(const struct hda_input_mux *imux, snd_ctl_elem_info_t *uinfo);
 101 int snd_hda_input_mux_put(struct hda_codec *codec, const struct hda_input_mux *imux,
 102                           snd_ctl_elem_value_t *ucontrol, hda_nid_t nid,
 103                           unsigned int *cur_val);
 104
 105 /*
 106  * Multi-channel / digital-out PCM helper
 107  */
 108
 109 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
 110 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
 111
 112 struct hda_multi_out {
 113         int num_dacs;           /* # of DACs, must be more than 1 */
 114         hda_nid_t *dac_nids;    /* DAC list */
 115         hda_nid_t hp_nid;       /* optional DAC for HP, 0 when not exists */
 116         hda_nid_t dig_out_nid;  /* digital out audio widget */
 117         int max_channels;       /* currently supported analog channels */
 118         int dig_out_used;       /* current usage of digital out (HDA_DIG_XXX) */
 119 };
 120
 121 int snd_hda_multi_out_dig_open(struct hda_codec *codec, struct hda_multi_out *mout);
 122 int snd_hda_multi_out_dig_close(struct hda_codec *codec, struct hda_multi_out *mout);
 123 int snd_hda_multi_out_analog_open(struct hda_codec *codec, struct hda_multi_out *mout,
 124                                   snd_pcm_substream_t *substream);
 125 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec, struct hda_multi_out *mout,
 126                                      unsigned int stream_tag,
 127                                      unsigned int format,
 128                                      snd_pcm_substream_t *substream);
 129 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec, struct hda_multi_out *mout);
 130
 131 /*
 132  * generic codec parser
 133  */
 134 int snd_hda_parse_generic_codec(struct hda_codec *codec);
 135
 136 /*
 137  * generic proc interface
 138  */
 139 #ifdef CONFIG_PROC_FS
 140 int snd_hda_codec_proc_new(struct hda_codec *codec);
 141 #else
 142 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
 143 #endif
 144
 145 /*
 146  * Misc
 147  */
 148 struct hda_board_config {
 149         const char *modelname;
 150         int config;
 151         unsigned short pci_subvendor;
 152         unsigned short pci_subdevice;
 153 };
 154
 155 int snd_hda_check_board_config(struct hda_codec *codec, const struct hda_board_config *tbl);
 156 int snd_hda_add_new_ctls(struct hda_codec *codec, snd_kcontrol_new_t *knew);
 157
 158 /*
 159  * power management
 160  */
 161 #ifdef CONFIG_PM
 162 int snd_hda_resume_ctls(struct hda_codec *codec, snd_kcontrol_new_t *knew);
 163 int snd_hda_resume_spdif_out(struct hda_codec *codec);
 164 int snd_hda_resume_spdif_in(struct hda_codec *codec);
 165 #endif
 166
 167 /*
 168  * unsolicited event handler
 169  */
 170
 171 #define HDA_UNSOL_QUEUE_SIZE    64
 172
 173 struct hda_bus_unsolicited {
 174         /* ring buffer */
 175         u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
 176         unsigned int rp, wp;
 177
 178         /* workqueue */
 179         struct workqueue_struct *workq;
 180         struct work_struct work;
 181 };
 182
 183 /*
 184  * Helper for automatic ping configuration
 185  */
 186
 187 enum {
 188         AUTO_PIN_MIC,
 189         AUTO_PIN_FRONT_MIC,
 190         AUTO_PIN_LINE,
 191         AUTO_PIN_FRONT_LINE,
 192         AUTO_PIN_CD,
 193         AUTO_PIN_AUX,
 194         AUTO_PIN_LAST
 195 };
 196
 197 struct auto_pin_cfg {
 198         int line_outs;
 199         hda_nid_t line_out_pins[4]; /* sorted in the order of Front/Surr/CLFE/Side */
 200         hda_nid_t hp_pin;
 201         hda_nid_t input_pins[AUTO_PIN_LAST];
 202         hda_nid_t dig_out_pin;
 203         hda_nid_t dig_in_pin;
 204 };
 205
 206 #define get_defcfg_connect(cfg) ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
 207 #define get_defcfg_association(cfg) ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
 208 #define get_defcfg_location(cfg) ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
 209 #define get_defcfg_sequence(cfg) (cfg & AC_DEFCFG_SEQUENCE)
 210 #define get_defcfg_device(cfg) ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
 211
 212 int snd_hda_parse_pin_def_config(struct hda_codec *codec, struct auto_pin_cfg *cfg);
 213
 214 #endif /* __SOUND_HDA_LOCAL_H */