[net-next-2.6.git] / sound / pci / hda / hda_local.h

/*
 * Universal Interface for Intel High Definition Audio Codec
 *
 * Local helper functions
 *
 * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
 *
 *  This program is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by the Free
 *  Software Foundation; either version 2 of the License, or (at your option)
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful, but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 *  more details.
 *
 *  You should have received a copy of the GNU General Public License along with
 *  this program; if not, write to the Free Software Foundation, Inc., 59
 *  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#ifndef __SOUND_HDA_LOCAL_H
#define __SOUND_HDA_LOCAL_H

/*
 * for mixer controls
 */
#define HDA_COMPOSE_AMP_VAL(nid,chs,idx,dir) \
	((nid) | ((chs)<<16) | ((dir)<<18) | ((idx)<<19))
/* mono volume with index (index=0,1,...) (channel=1,2) */
#define HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx,  \
	  .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | \
	  	    SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
	  	    SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
	  .info = snd_hda_mixer_amp_volume_info, \
	  .get = snd_hda_mixer_amp_volume_get, \
	  .put = snd_hda_mixer_amp_volume_put, \
	  .tlv = { .c = snd_hda_mixer_amp_tlv },		\
	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
/* stereo volume with index */
#define HDA_CODEC_VOLUME_IDX(xname, xcidx, nid, xindex, direction) \
	HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
/* mono volume */
#define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) \
	HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, channel, xindex, direction)
/* stereo volume */
#define HDA_CODEC_VOLUME(xname, nid, xindex, direction) \
	HDA_CODEC_VOLUME_MONO(xname, nid, 3, xindex, direction)
/* mono mute switch with index (index=0,1,...) (channel=1,2) */
#define HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
	  .info = snd_hda_mixer_amp_switch_info, \
	  .get = snd_hda_mixer_amp_switch_get, \
	  .put = snd_hda_mixer_amp_switch_put, \
	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
/* stereo mute switch with index */
#define HDA_CODEC_MUTE_IDX(xname, xcidx, nid, xindex, direction) \
	HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
/* mono mute switch */
#define HDA_CODEC_MUTE_MONO(xname, nid, channel, xindex, direction) \
	HDA_CODEC_MUTE_MONO_IDX(xname, 0, nid, channel, xindex, direction)
/* stereo mute switch */
#define HDA_CODEC_MUTE(xname, nid, xindex, direction) \
	HDA_CODEC_MUTE_MONO(xname, nid, 3, xindex, direction)

int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_info *uinfo);
int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol,
				 struct snd_ctl_elem_value *ucontrol);
int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol,
				 struct snd_ctl_elem_value *ucontrol);
int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag,
			  unsigned int size, unsigned int __user *tlv);
int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_info *uinfo);
int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol,
				 struct snd_ctl_elem_value *ucontrol);
int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol,
				 struct snd_ctl_elem_value *ucontrol);
/* lowlevel accessor with caching; use carefully */
int snd_hda_codec_amp_read(struct hda_codec *codec, hda_nid_t nid, int ch,
			   int direction, int index);
int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch,
			     int direction, int idx, int mask, int val);
int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid,
			     int dir, int idx, int mask, int val);
#ifdef SND_HDA_NEEDS_RESUME
void snd_hda_codec_resume_amp(struct hda_codec *codec);
#endif

void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
			     unsigned int *tlv);
struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
					    const char *name);
int snd_hda_add_vmaster(struct hda_codec *codec, char *name,
			unsigned int *tlv, const char **slaves);
void snd_hda_codec_reset(struct hda_codec *codec);
int snd_hda_codec_configure(struct hda_codec *codec);

/* amp value bits */
#define HDA_AMP_MUTE	0x80
#define HDA_AMP_UNMUTE	0x00
#define HDA_AMP_VOLMASK	0x7f

/* mono switch binding multiple inputs */
#define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0,  \
	  .info = snd_hda_mixer_amp_switch_info, \
	  .get = snd_hda_mixer_bind_switch_get, \
	  .put = snd_hda_mixer_bind_switch_put, \
	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }

/* stereo switch binding multiple inputs */
#define HDA_BIND_MUTE(xname,nid,indices,dir) \
	HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)

int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_value *ucontrol);
int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_value *ucontrol);

/* more generic bound controls */
struct hda_ctl_ops {
	snd_kcontrol_info_t *info;
	snd_kcontrol_get_t *get;
	snd_kcontrol_put_t *put;
	snd_kcontrol_tlv_rw_t *tlv;
};

extern struct hda_ctl_ops snd_hda_bind_vol;	/* for bind-volume with TLV */
extern struct hda_ctl_ops snd_hda_bind_sw;	/* for bind-switch */

struct hda_bind_ctls {
	struct hda_ctl_ops *ops;
	long values[];
};

int snd_hda_mixer_bind_ctls_info(struct snd_kcontrol *kcontrol,
				 struct snd_ctl_elem_info *uinfo);
int snd_hda_mixer_bind_ctls_get(struct snd_kcontrol *kcontrol,
				struct snd_ctl_elem_value *ucontrol);
int snd_hda_mixer_bind_ctls_put(struct snd_kcontrol *kcontrol,
				struct snd_ctl_elem_value *ucontrol);
int snd_hda_mixer_bind_tlv(struct snd_kcontrol *kcontrol, int op_flag,
			   unsigned int size, unsigned int __user *tlv);

#define HDA_BIND_VOL(xname, bindrec) \
	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
	  .name = xname, \
	  .access = SNDRV_CTL_ELEM_ACCESS_READWRITE |\
			  SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
			  SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,\
	  .info = snd_hda_mixer_bind_ctls_info,\
	  .get =  snd_hda_mixer_bind_ctls_get,\
	  .put = snd_hda_mixer_bind_ctls_put,\
	  .tlv = { .c = snd_hda_mixer_bind_tlv },\
	  .private_value = (long) (bindrec) }
#define HDA_BIND_SW(xname, bindrec) \
	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER,\
	  .name = xname, \
	  .info = snd_hda_mixer_bind_ctls_info,\
	  .get =  snd_hda_mixer_bind_ctls_get,\
	  .put = snd_hda_mixer_bind_ctls_put,\
	  .private_value = (long) (bindrec) }

/*
 * SPDIF I/O
 */
int snd_hda_create_spdif_out_ctls(struct hda_codec *codec, hda_nid_t nid);
int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);

/*
 * input MUX helper
 */
#define HDA_MAX_NUM_INPUTS	16
struct hda_input_mux_item {
	const char *label;
	unsigned int index;
};
struct hda_input_mux {
	unsigned int num_items;
	struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
};

int snd_hda_input_mux_info(const struct hda_input_mux *imux,
			   struct snd_ctl_elem_info *uinfo);
int snd_hda_input_mux_put(struct hda_codec *codec,
			  const struct hda_input_mux *imux,
			  struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
			  unsigned int *cur_val);

/*
 * Channel mode helper
 */
struct hda_channel_mode {
	int channels;
	const struct hda_verb *sequence;
};

int snd_hda_ch_mode_info(struct hda_codec *codec,
			 struct snd_ctl_elem_info *uinfo,
			 const struct hda_channel_mode *chmode,
			 int num_chmodes);
int snd_hda_ch_mode_get(struct hda_codec *codec,
			struct snd_ctl_elem_value *ucontrol,
			const struct hda_channel_mode *chmode,
			int num_chmodes,
			int max_channels);
int snd_hda_ch_mode_put(struct hda_codec *codec,
			struct snd_ctl_elem_value *ucontrol,
			const struct hda_channel_mode *chmode,
			int num_chmodes,
			int *max_channelsp);

/*
 * Multi-channel / digital-out PCM helper
 */

enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */

struct hda_multi_out {
	int num_dacs;		/* # of DACs, must be more than 1 */
	hda_nid_t *dac_nids;	/* DAC list */
	hda_nid_t hp_nid;	/* optional DAC for HP, 0 when not exists */
	hda_nid_t extra_out_nid[3];	/* optional DACs, 0 when not exists */
	hda_nid_t dig_out_nid;	/* digital out audio widget */
	int max_channels;	/* currently supported analog channels */
	int dig_out_used;	/* current usage of digital out (HDA_DIG_XXX) */
	int no_share_stream;	/* don't share a stream with multiple pins */
	int share_spdif;	/* share SPDIF pin */
	/* PCM information for both analog and SPDIF DACs */
	unsigned int analog_rates;
	unsigned int analog_maxbps;
	u64 analog_formats;
	unsigned int spdif_rates;
	unsigned int spdif_maxbps;
	u64 spdif_formats;
};

int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
				  struct hda_multi_out *mout);
int snd_hda_multi_out_dig_open(struct hda_codec *codec,
			       struct hda_multi_out *mout);
int snd_hda_multi_out_dig_close(struct hda_codec *codec,
				struct hda_multi_out *mout);
int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
				  struct hda_multi_out *mout,
				  unsigned int stream_tag,
				  unsigned int format,
				  struct snd_pcm_substream *substream);
int snd_hda_multi_out_analog_open(struct hda_codec *codec,
				  struct hda_multi_out *mout,
				  struct snd_pcm_substream *substream,
				  struct hda_pcm_stream *hinfo);
int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
				     struct hda_multi_out *mout,
				     unsigned int stream_tag,
				     unsigned int format,
				     struct snd_pcm_substream *substream);
int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
				     struct hda_multi_out *mout);

/*
 * generic codec parser
 */
#ifdef CONFIG_SND_HDA_GENERIC
int snd_hda_parse_generic_codec(struct hda_codec *codec);
#else
static inline int snd_hda_parse_generic_codec(struct hda_codec *codec)
{
	return -ENODEV;
}
#endif

/*
 * generic proc interface
 */
#ifdef CONFIG_PROC_FS
int snd_hda_codec_proc_new(struct hda_codec *codec);
#else
static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
#endif

#define SND_PRINT_RATES_ADVISED_BUFSIZE	80
void snd_print_pcm_rates(int pcm, char *buf, int buflen);

/*
 * Misc
 */
int snd_hda_check_board_config(struct hda_codec *codec, int num_configs,
			       const char **modelnames,
			       const struct snd_pci_quirk *pci_list);
int snd_hda_add_new_ctls(struct hda_codec *codec,
			 struct snd_kcontrol_new *knew);

/*
 * unsolicited event handler
 */

#define HDA_UNSOL_QUEUE_SIZE	64

struct hda_bus_unsolicited {
	/* ring buffer */
	u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
	unsigned int rp, wp;

	/* workqueue */
	struct work_struct work;
	struct hda_bus *bus;
};

/*
 * Helper for automatic ping configuration
 */

enum {
	AUTO_PIN_MIC,
	AUTO_PIN_FRONT_MIC,
	AUTO_PIN_LINE,
	AUTO_PIN_FRONT_LINE,
	AUTO_PIN_CD,
	AUTO_PIN_AUX,
	AUTO_PIN_LAST
};

enum {
	AUTO_PIN_LINE_OUT,
	AUTO_PIN_SPEAKER_OUT,
	AUTO_PIN_HP_OUT
};

extern const char *auto_pin_cfg_labels[AUTO_PIN_LAST];

#define AUTO_CFG_MAX_OUTS	5

struct auto_pin_cfg {
	int line_outs;
	/* sorted in the order of Front/Surr/CLFE/Side */
	hda_nid_t line_out_pins[AUTO_CFG_MAX_OUTS];
	int speaker_outs;
	hda_nid_t speaker_pins[AUTO_CFG_MAX_OUTS];
	int hp_outs;
	int line_out_type;	/* AUTO_PIN_XXX_OUT */
	hda_nid_t hp_pins[AUTO_CFG_MAX_OUTS];
	hda_nid_t input_pins[AUTO_PIN_LAST];
	hda_nid_t dig_out_pin;
	hda_nid_t dig_in_pin;
	hda_nid_t mono_out_pin;
};

#define get_defcfg_connect(cfg) \
	((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
#define get_defcfg_association(cfg) \
	((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
#define get_defcfg_location(cfg) \
	((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
#define get_defcfg_sequence(cfg) \
	(cfg & AC_DEFCFG_SEQUENCE)
#define get_defcfg_device(cfg) \
	((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)

int snd_hda_parse_pin_def_config(struct hda_codec *codec,
				 struct auto_pin_cfg *cfg,
				 hda_nid_t *ignore_nids);

/* amp values */
#define AMP_IN_MUTE(idx)	(0x7080 | ((idx)<<8))
#define AMP_IN_UNMUTE(idx)	(0x7000 | ((idx)<<8))
#define AMP_OUT_MUTE		0xb080
#define AMP_OUT_UNMUTE		0xb000
#define AMP_OUT_ZERO		0xb000
/* pinctl values */
#define PIN_IN			(AC_PINCTL_IN_EN)
#define PIN_VREFHIZ		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
#define PIN_VREF50		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
#define PIN_VREFGRD		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
#define PIN_VREF80		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
#define PIN_VREF100		(AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
#define PIN_OUT			(AC_PINCTL_OUT_EN)
#define PIN_HP			(AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
#define PIN_HP_AMP		(AC_PINCTL_HP_EN)

/*
 * get widget capabilities
 */
static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
{
	if (nid < codec->start_nid ||
	    nid >= codec->start_nid + codec->num_nodes)
		return 0;
	return codec->wcaps[nid - codec->start_nid];
}

u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
			      unsigned int caps);

int snd_hda_ctl_add(struct hda_codec *codec, struct snd_kcontrol *kctl);
void snd_hda_ctls_clear(struct hda_codec *codec);

/*
 * hwdep interface
 */
#ifdef CONFIG_SND_HDA_HWDEP
int snd_hda_create_hwdep(struct hda_codec *codec);
int snd_hda_hwdep_add_sysfs(struct hda_codec *codec);
#else
static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
#endif

/*
 * power-management
 */

#ifdef CONFIG_SND_HDA_POWER_SAVE
void snd_hda_schedule_power_save(struct hda_codec *codec);

struct hda_amp_list {
	hda_nid_t nid;
	unsigned char dir;
	unsigned char idx;
};

struct hda_loopback_check {
	struct hda_amp_list *amplist;
	int power_on;
};

int snd_hda_check_amp_list_power(struct hda_codec *codec,
				 struct hda_loopback_check *check,
				 hda_nid_t nid);
#endif /* CONFIG_SND_HDA_POWER_SAVE */

/*
 * AMP control callbacks
 */
/* retrieve parameters from private_value */
#define get_amp_nid(kc)		((kc)->private_value & 0xffff)
#define get_amp_channels(kc)	(((kc)->private_value >> 16) & 0x3)
#define get_amp_direction(kc)	(((kc)->private_value >> 18) & 0x1)
#define get_amp_index(kc)	(((kc)->private_value >> 19) & 0xf)

/*
 * CEA Short Audio Descriptor data
 */
struct cea_sad {
	int	channels;
	int	format;		/* (format == 0) indicates invalid SAD */
	int	rates;
	int	sample_bits;	/* for LPCM */
	int	max_bitrate;	/* for AC3...ATRAC */
	int	profile;	/* for WMAPRO */
};

#define ELD_FIXED_BYTES	20
#define ELD_MAX_MNL	16
#define ELD_MAX_SAD	16

/*
 * ELD: EDID Like Data
 */
struct sink_eld {
	int	eld_size;
	int	baseline_len;
	int	eld_ver;	/* (eld_ver == 0) indicates invalid ELD */
	int	cea_edid_ver;
	char	monitor_name[ELD_MAX_MNL + 1];
	int	manufacture_id;
	int	product_id;
	u64	port_id;
	int	support_hdcp;
	int	support_ai;
	int	conn_type;
	int	aud_synch_delay;
	int	spk_alloc;
	int	sad_count;
	struct cea_sad sad[ELD_MAX_SAD];
};

int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
int snd_hdmi_get_eld(struct sink_eld *, struct hda_codec *, hda_nid_t);
void snd_hdmi_show_eld(struct sink_eld *eld);

#ifdef CONFIG_PROC_FS
int snd_hda_eld_proc_new(struct hda_codec *codec, struct sink_eld *eld);
#else
inline int snd_hda_eld_proc_new(struct hda_codec *codec, struct sink_eld *eld)
{
	return 0;
}
#endif

#endif /* __SOUND_HDA_LOCAL_H */
Commit	Line	Data
1da177e4 LT	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	*/
d01ce99f TI	29	#define HDA_COMPOSE_AMP_VAL(nid,chs,idx,dir) \
d01ce99f TI	30	((nid) \| ((chs)<<16) \| ((dir)<<18) \| ((idx)<<19))
985be54b	31	/* mono volume with index (index=0,1,...) (channel=1,2) */
1da177e4 LT	32	#define HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
1da177e4 LT	33	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
302e9c5a JK	34	.access = SNDRV_CTL_ELEM_ACCESS_READWRITE \| \
	35	SNDRV_CTL_ELEM_ACCESS_TLV_READ \| \
	36	SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
1da177e4 LT	37	.info = snd_hda_mixer_amp_volume_info, \
	38	.get = snd_hda_mixer_amp_volume_get, \
	39	.put = snd_hda_mixer_amp_volume_put, \
7cf0a953	40	.tlv = { .c = snd_hda_mixer_amp_tlv }, \
1da177e4	41	.private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
985be54b	42	/* stereo volume with index */
1da177e4 LT	43	#define HDA_CODEC_VOLUME_IDX(xname, xcidx, nid, xindex, direction) \
1da177e4 LT	44	HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
985be54b	45	/* mono volume */
1da177e4 LT	46	#define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) \
1da177e4 LT	47	HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, channel, xindex, direction)
985be54b	48	/* stereo volume */
1da177e4 LT	49	#define HDA_CODEC_VOLUME(xname, nid, xindex, direction) \
1da177e4 LT	50	HDA_CODEC_VOLUME_MONO(xname, nid, 3, xindex, direction)
985be54b	51	/* mono mute switch with index (index=0,1,...) (channel=1,2) */
1da177e4 LT	52	#define HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
	53	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
	54	.info = snd_hda_mixer_amp_switch_info, \
	55	.get = snd_hda_mixer_amp_switch_get, \
	56	.put = snd_hda_mixer_amp_switch_put, \
	57	.private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
985be54b	58	/* stereo mute switch with index */
1da177e4 LT	59	#define HDA_CODEC_MUTE_IDX(xname, xcidx, nid, xindex, direction) \
1da177e4 LT	60	HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
985be54b	61	/* mono mute switch */
1da177e4 LT	62	#define HDA_CODEC_MUTE_MONO(xname, nid, channel, xindex, direction) \
1da177e4 LT	63	HDA_CODEC_MUTE_MONO_IDX(xname, 0, nid, channel, xindex, direction)
985be54b	64	/* stereo mute switch */
1da177e4 LT	65	#define HDA_CODEC_MUTE(xname, nid, xindex, direction) \
	66	HDA_CODEC_MUTE_MONO(xname, nid, 3, xindex, direction)
	67
d01ce99f TI	68	int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol,
	69	struct snd_ctl_elem_info *uinfo);
	70	int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol,
	71	struct snd_ctl_elem_value *ucontrol);
	72	int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol,
	73	struct snd_ctl_elem_value *ucontrol);
	74	int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag,
	75	unsigned int size, unsigned int __user *tlv);
	76	int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol,
	77	struct snd_ctl_elem_info *uinfo);
	78	int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol,
	79	struct snd_ctl_elem_value *ucontrol);
	80	int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol,
	81	struct snd_ctl_elem_value *ucontrol);
834be88d TI	82	/* lowlevel accessor with caching; use carefully */
	83	int snd_hda_codec_amp_read(struct hda_codec *codec, hda_nid_t nid, int ch,
	84	int direction, int index);
	85	int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch,
	86	int direction, int idx, int mask, int val);
47fd830a TI	87	int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid,
47fd830a TI	88	int dir, int idx, int mask, int val);
cb53c626	89	#ifdef SND_HDA_NEEDS_RESUME
b3ac5636	90	void snd_hda_codec_resume_amp(struct hda_codec *codec);
82beb8fd	91	#endif
1da177e4	92
2134ea4f TI	93	void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
	94	unsigned int *tlv);
	95	struct snd_kcontrol snd_hda_find_mixer_ctl(struct hda_codec codec,
	96	const char *name);
	97	int snd_hda_add_vmaster(struct hda_codec codec, char name,
	98	unsigned int tlv, const char *slaves);
6c1f45ea TI	99	void snd_hda_codec_reset(struct hda_codec *codec);
6c1f45ea TI	100	int snd_hda_codec_configure(struct hda_codec *codec);
2134ea4f	101
47fd830a TI	102	/* amp value bits */
	103	#define HDA_AMP_MUTE 0x80
	104	#define HDA_AMP_UNMUTE 0x00
	105	#define HDA_AMP_VOLMASK 0x7f
	106
985be54b TI	107	/* mono switch binding multiple inputs */
	108	#define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
	109	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0, \
	110	.info = snd_hda_mixer_amp_switch_info, \
	111	.get = snd_hda_mixer_bind_switch_get, \
	112	.put = snd_hda_mixer_bind_switch_put, \
	113	.private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }
	114
	115	/* stereo switch binding multiple inputs */
d01ce99f TI	116	#define HDA_BIND_MUTE(xname,nid,indices,dir) \
d01ce99f TI	117	HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
985be54b	118
d01ce99f TI	119	int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
	120	struct snd_ctl_elem_value *ucontrol);
	121	int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
	122	struct snd_ctl_elem_value *ucontrol);
985be54b	123
532d5381 TI	124	/* more generic bound controls */
	125	struct hda_ctl_ops {
	126	snd_kcontrol_info_t *info;
	127	snd_kcontrol_get_t *get;
	128	snd_kcontrol_put_t *put;
	129	snd_kcontrol_tlv_rw_t *tlv;
	130	};
	131
	132	extern struct hda_ctl_ops snd_hda_bind_vol; /* for bind-volume with TLV */
	133	extern struct hda_ctl_ops snd_hda_bind_sw; /* for bind-switch */
	134
	135	struct hda_bind_ctls {
	136	struct hda_ctl_ops *ops;
	137	long values[];
	138	};
	139
	140	int snd_hda_mixer_bind_ctls_info(struct snd_kcontrol *kcontrol,
	141	struct snd_ctl_elem_info *uinfo);
	142	int snd_hda_mixer_bind_ctls_get(struct snd_kcontrol *kcontrol,
	143	struct snd_ctl_elem_value *ucontrol);
	144	int snd_hda_mixer_bind_ctls_put(struct snd_kcontrol *kcontrol,
	145	struct snd_ctl_elem_value *ucontrol);
	146	int snd_hda_mixer_bind_tlv(struct snd_kcontrol *kcontrol, int op_flag,
	147	unsigned int size, unsigned int __user *tlv);
	148
	149	#define HDA_BIND_VOL(xname, bindrec) \
	150	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
	151	.name = xname, \
	152	.access = SNDRV_CTL_ELEM_ACCESS_READWRITE \|\
	153	SNDRV_CTL_ELEM_ACCESS_TLV_READ \|\
	154	SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,\
	155	.info = snd_hda_mixer_bind_ctls_info,\
	156	.get = snd_hda_mixer_bind_ctls_get,\
	157	.put = snd_hda_mixer_bind_ctls_put,\
	158	.tlv = { .c = snd_hda_mixer_bind_tlv },\
	159	.private_value = (long) (bindrec) }
	160	#define HDA_BIND_SW(xname, bindrec) \
	161	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER,\
	162	.name = xname, \
	163	.info = snd_hda_mixer_bind_ctls_info,\
	164	.get = snd_hda_mixer_bind_ctls_get,\
	165	.put = snd_hda_mixer_bind_ctls_put,\
	166	.private_value = (long) (bindrec) }
	167
	168	/*
	169	* SPDIF I/O
	170	*/
1da177e4 LT	171	int snd_hda_create_spdif_out_ctls(struct hda_codec *codec, hda_nid_t nid);
	172	int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
	173
	174	/*
	175	* input MUX helper
	176	*/
54d17403	177	#define HDA_MAX_NUM_INPUTS 16
1da177e4 LT	178	struct hda_input_mux_item {
	179	const char *label;
	180	unsigned int index;
	181	};
	182	struct hda_input_mux {
	183	unsigned int num_items;
	184	struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
	185	};
	186
d01ce99f TI	187	int snd_hda_input_mux_info(const struct hda_input_mux *imux,
	188	struct snd_ctl_elem_info *uinfo);
	189	int snd_hda_input_mux_put(struct hda_codec *codec,
	190	const struct hda_input_mux *imux,
c8b6bf9b	191	struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
1da177e4 LT	192	unsigned int *cur_val);
1da177e4 LT	193
c8b6bf9b	194	/*
d2a6d7dc TI	195	* Channel mode helper
	196	*/
	197	struct hda_channel_mode {
	198	int channels;
	199	const struct hda_verb *sequence;
	200	};
	201
d01ce99f TI	202	int snd_hda_ch_mode_info(struct hda_codec *codec,
	203	struct snd_ctl_elem_info *uinfo,
	204	const struct hda_channel_mode *chmode,
	205	int num_chmodes);
	206	int snd_hda_ch_mode_get(struct hda_codec *codec,
	207	struct snd_ctl_elem_value *ucontrol,
	208	const struct hda_channel_mode *chmode,
	209	int num_chmodes,
d2a6d7dc	210	int max_channels);
d01ce99f TI	211	int snd_hda_ch_mode_put(struct hda_codec *codec,
	212	struct snd_ctl_elem_value *ucontrol,
	213	const struct hda_channel_mode *chmode,
	214	int num_chmodes,
d2a6d7dc TI	215	int *max_channelsp);
d2a6d7dc TI	216
1da177e4 LT	217	/*
	218	* Multi-channel / digital-out PCM helper
	219	*/
	220
	221	enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
	222	enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
	223
	224	struct hda_multi_out {
	225	int num_dacs; /* # of DACs, must be more than 1 */
	226	hda_nid_t dac_nids; / DAC list */
	227	hda_nid_t hp_nid; /* optional DAC for HP, 0 when not exists */
82bc955f	228	hda_nid_t extra_out_nid[3]; /* optional DACs, 0 when not exists */
1da177e4 LT	229	hda_nid_t dig_out_nid; /* digital out audio widget */
	230	int max_channels; /* currently supported analog channels */
	231	int dig_out_used; /* current usage of digital out (HDA_DIG_XXX) */
d29240ce	232	int no_share_stream; /* don't share a stream with multiple pins */
9a08160b TI	233	int share_spdif; /* share SPDIF pin */
	234	/* PCM information for both analog and SPDIF DACs */
	235	unsigned int analog_rates;
	236	unsigned int analog_maxbps;
	237	u64 analog_formats;
	238	unsigned int spdif_rates;
	239	unsigned int spdif_maxbps;
	240	u64 spdif_formats;
1da177e4 LT	241	};
1da177e4 LT	242
9a08160b TI	243	int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
9a08160b TI	244	struct hda_multi_out *mout);
d01ce99f TI	245	int snd_hda_multi_out_dig_open(struct hda_codec *codec,
	246	struct hda_multi_out *mout);
	247	int snd_hda_multi_out_dig_close(struct hda_codec *codec,
	248	struct hda_multi_out *mout);
6b97eb45 TI	249	int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
	250	struct hda_multi_out *mout,
	251	unsigned int stream_tag,
	252	unsigned int format,
	253	struct snd_pcm_substream *substream);
d01ce99f TI	254	int snd_hda_multi_out_analog_open(struct hda_codec *codec,
d01ce99f TI	255	struct hda_multi_out *mout,
9a08160b TI	256	struct snd_pcm_substream *substream,
9a08160b TI	257	struct hda_pcm_stream *hinfo);
d01ce99f TI	258	int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
d01ce99f TI	259	struct hda_multi_out *mout,
1da177e4 LT	260	unsigned int stream_tag,
1da177e4 LT	261	unsigned int format,
c8b6bf9b	262	struct snd_pcm_substream *substream);
d01ce99f TI	263	int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
d01ce99f TI	264	struct hda_multi_out *mout);
1da177e4 LT	265
	266	/*
	267	* generic codec parser
	268	*/
35a1e0cc	269	#ifdef CONFIG_SND_HDA_GENERIC
1da177e4	270	int snd_hda_parse_generic_codec(struct hda_codec *codec);
35a1e0cc TI	271	#else
	272	static inline int snd_hda_parse_generic_codec(struct hda_codec *codec)
	273	{
	274	return -ENODEV;
	275	}
	276	#endif
1da177e4 LT	277
	278	/*
	279	* generic proc interface
	280	*/
	281	#ifdef CONFIG_PROC_FS
	282	int snd_hda_codec_proc_new(struct hda_codec *codec);
	283	#else
	284	static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
	285	#endif
	286
33deeca3 WF	287	#define SND_PRINT_RATES_ADVISED_BUFSIZE 80
	288	void snd_print_pcm_rates(int pcm, char *buf, int buflen);
	289
1da177e4 LT	290	/*
	291	* Misc
	292	*/
f5fcc13c TI	293	int snd_hda_check_board_config(struct hda_codec *codec, int num_configs,
	294	const char **modelnames,
	295	const struct snd_pci_quirk *pci_list);
d01ce99f TI	296	int snd_hda_add_new_ctls(struct hda_codec *codec,
d01ce99f TI	297	struct snd_kcontrol_new *knew);
1da177e4	298
1da177e4 LT	299	/*
	300	* unsolicited event handler
	301	*/
	302
	303	#define HDA_UNSOL_QUEUE_SIZE 64
	304
	305	struct hda_bus_unsolicited {
	306	/* ring buffer */
	307	u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
	308	unsigned int rp, wp;
	309
	310	/* workqueue */
1da177e4	311	struct work_struct work;
c4028958	312	struct hda_bus *bus;
1da177e4 LT	313	};
1da177e4 LT	314
e9edcee0 TI	315	/*
	316	* Helper for automatic ping configuration
	317	*/
	318
	319	enum {
	320	AUTO_PIN_MIC,
	321	AUTO_PIN_FRONT_MIC,
	322	AUTO_PIN_LINE,
	323	AUTO_PIN_FRONT_LINE,
	324	AUTO_PIN_CD,
	325	AUTO_PIN_AUX,
	326	AUTO_PIN_LAST
	327	};
	328
d258e24a TI	329	enum {
	330	AUTO_PIN_LINE_OUT,
	331	AUTO_PIN_SPEAKER_OUT,
	332	AUTO_PIN_HP_OUT
	333	};
	334
4a471b7d TI	335	extern const char *auto_pin_cfg_labels[AUTO_PIN_LAST];
4a471b7d TI	336
41923e44 TI	337	#define AUTO_CFG_MAX_OUTS 5
41923e44 TI	338
e9edcee0 TI	339	struct auto_pin_cfg {
e9edcee0 TI	340	int line_outs;
41923e44 TI	341	/* sorted in the order of Front/Surr/CLFE/Side */
41923e44 TI	342	hda_nid_t line_out_pins[AUTO_CFG_MAX_OUTS];
82bc955f	343	int speaker_outs;
41923e44	344	hda_nid_t speaker_pins[AUTO_CFG_MAX_OUTS];
eb06ed8f	345	int hp_outs;
d258e24a	346	int line_out_type; /* AUTO_PIN_XXX_OUT */
41923e44	347	hda_nid_t hp_pins[AUTO_CFG_MAX_OUTS];
e9edcee0 TI	348	hda_nid_t input_pins[AUTO_PIN_LAST];
	349	hda_nid_t dig_out_pin;
	350	hda_nid_t dig_in_pin;
90da78bf	351	hda_nid_t mono_out_pin;
e9edcee0 TI	352	};
e9edcee0 TI	353
d01ce99f TI	354	#define get_defcfg_connect(cfg) \
	355	((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
	356	#define get_defcfg_association(cfg) \
	357	((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
	358	#define get_defcfg_location(cfg) \
	359	((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
	360	#define get_defcfg_sequence(cfg) \
	361	(cfg & AC_DEFCFG_SEQUENCE)
	362	#define get_defcfg_device(cfg) \
	363	((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
	364
	365	int snd_hda_parse_pin_def_config(struct hda_codec *codec,
	366	struct auto_pin_cfg *cfg,
df694daa	367	hda_nid_t *ignore_nids);
e9edcee0	368
8d88bc3d TI	369	/* amp values */
	370	#define AMP_IN_MUTE(idx) (0x7080 \| ((idx)<<8))
	371	#define AMP_IN_UNMUTE(idx) (0x7000 \| ((idx)<<8))
d301fc32 TI	372	#define AMP_OUT_MUTE 0xb080
	373	#define AMP_OUT_UNMUTE 0xb000
	374	#define AMP_OUT_ZERO 0xb000
8d88bc3d	375	/* pinctl values */
35e8901e	376	#define PIN_IN (AC_PINCTL_IN_EN)
d301fc32	377	#define PIN_VREFHIZ (AC_PINCTL_IN_EN \| AC_PINCTL_VREF_HIZ)
35e8901e	378	#define PIN_VREF50 (AC_PINCTL_IN_EN \| AC_PINCTL_VREF_50)
d301fc32	379	#define PIN_VREFGRD (AC_PINCTL_IN_EN \| AC_PINCTL_VREF_GRD)
35e8901e	380	#define PIN_VREF80 (AC_PINCTL_IN_EN \| AC_PINCTL_VREF_80)
d301fc32 TI	381	#define PIN_VREF100 (AC_PINCTL_IN_EN \| AC_PINCTL_VREF_100)
d301fc32 TI	382	#define PIN_OUT (AC_PINCTL_OUT_EN)
35e8901e RJ	383	#define PIN_HP (AC_PINCTL_OUT_EN \| AC_PINCTL_HP_EN)
35e8901e RJ	384	#define PIN_HP_AMP (AC_PINCTL_HP_EN)
8d88bc3d	385
54d17403 TI	386	/*
	387	* get widget capabilities
	388	*/
	389	static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
	390	{
	391	if (nid < codec->start_nid \|\|
	392	nid >= codec->start_nid + codec->num_nodes)
dca008f3	393	return 0;
54d17403 TI	394	return codec->wcaps[nid - codec->start_nid];
	395	}
	396
09a99959	397	u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
897cc188 TI	398	int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
897cc188 TI	399	unsigned int caps);
54d17403	400
d13bd412 TI	401	int snd_hda_ctl_add(struct hda_codec codec, struct snd_kcontrol kctl);
	402	void snd_hda_ctls_clear(struct hda_codec *codec);
	403
2807314d TI	404	/*
	405	* hwdep interface
	406	*/
d7ffba19	407	#ifdef CONFIG_SND_HDA_HWDEP
2807314d	408	int snd_hda_create_hwdep(struct hda_codec *codec);
d7ffba19 TI	409	int snd_hda_hwdep_add_sysfs(struct hda_codec *codec);
	410	#else
	411	static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
	412	#endif
2807314d	413
cb53c626 TI	414	/*
	415	* power-management
	416	*/
	417
	418	#ifdef CONFIG_SND_HDA_POWER_SAVE
	419	void snd_hda_schedule_power_save(struct hda_codec *codec);
	420
	421	struct hda_amp_list {
	422	hda_nid_t nid;
	423	unsigned char dir;
	424	unsigned char idx;
	425	};
	426
	427	struct hda_loopback_check {
	428	struct hda_amp_list *amplist;
	429	int power_on;
	430	};
	431
	432	int snd_hda_check_amp_list_power(struct hda_codec *codec,
	433	struct hda_loopback_check *check,
	434	hda_nid_t nid);
	435	#endif /* CONFIG_SND_HDA_POWER_SAVE */
	436
89385035 MR	437	/*
	438	* AMP control callbacks
	439	*/
	440	/* retrieve parameters from private_value */
	441	#define get_amp_nid(kc) ((kc)->private_value & 0xffff)
	442	#define get_amp_channels(kc) (((kc)->private_value >> 16) & 0x3)
	443	#define get_amp_direction(kc) (((kc)->private_value >> 18) & 0x1)
	444	#define get_amp_index(kc) (((kc)->private_value >> 19) & 0xf)
	445
7f4a9f43 WF	446	/*
	447	* CEA Short Audio Descriptor data
	448	*/
	449	struct cea_sad {
	450	int channels;
	451	int format; /* (format == 0) indicates invalid SAD */
	452	int rates;
	453	int sample_bits; /* for LPCM */
	454	int max_bitrate; /* for AC3...ATRAC */
	455	int profile; /* for WMAPRO */
	456	};
	457
	458	#define ELD_FIXED_BYTES 20
	459	#define ELD_MAX_MNL 16
	460	#define ELD_MAX_SAD 16
	461
	462	/*
	463	* ELD: EDID Like Data
	464	*/
	465	struct sink_eld {
	466	int eld_size;
	467	int baseline_len;
	468	int eld_ver; /* (eld_ver == 0) indicates invalid ELD */
	469	int cea_edid_ver;
	470	char monitor_name[ELD_MAX_MNL + 1];
	471	int manufacture_id;
	472	int product_id;
	473	u64 port_id;
	474	int support_hdcp;
	475	int support_ai;
	476	int conn_type;
	477	int aud_synch_delay;
	478	int spk_alloc;
	479	int sad_count;
	480	struct cea_sad sad[ELD_MAX_SAD];
	481	};
	482
	483	int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
	484	int snd_hdmi_get_eld(struct sink_eld , struct hda_codec , hda_nid_t);
	485	void snd_hdmi_show_eld(struct sink_eld *eld);
	486
5f1e71b1 WF	487	#ifdef CONFIG_PROC_FS
	488	int snd_hda_eld_proc_new(struct hda_codec codec, struct sink_eld eld);
	489	#else
	490	inline int snd_hda_eld_proc_new(struct hda_codec codec, struct sink_eld eld)
	491	{
	492	return 0;
	493	}
	494	#endif
	495
1da177e4	496	#endif /* __SOUND_HDA_LOCAL_H */