[mirror_ubuntu-artful-kernel.git] / sound / pci / hda / hda_codec.h

/*
 * Universal Interface for Intel High Definition Audio Codec
 *
 * 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_CODEC_H
#define __SOUND_HDA_CODEC_H

#include <sound/info.h>
#include <sound/control.h>
#include <sound/pcm.h>
#include <sound/hwdep.h>

/*
 * nodes
 */
#define	AC_NODE_ROOT		0x00

/*
 * function group types
 */
enum {
	AC_GRP_AUDIO_FUNCTION = 0x01,
	AC_GRP_MODEM_FUNCTION = 0x02,
};
	
/*
 * widget types
 */
enum {
	AC_WID_AUD_OUT,		/* Audio Out */
	AC_WID_AUD_IN,		/* Audio In */
	AC_WID_AUD_MIX,		/* Audio Mixer */
	AC_WID_AUD_SEL,		/* Audio Selector */
	AC_WID_PIN,		/* Pin Complex */
	AC_WID_POWER,		/* Power */
	AC_WID_VOL_KNB,		/* Volume Knob */
	AC_WID_BEEP,		/* Beep Generator */
	AC_WID_VENDOR = 0x0f	/* Vendor specific */
};

/*
 * GET verbs
 */
#define AC_VERB_GET_STREAM_FORMAT		0x0a00
#define AC_VERB_GET_AMP_GAIN_MUTE		0x0b00
#define AC_VERB_GET_PROC_COEF			0x0c00
#define AC_VERB_GET_COEF_INDEX			0x0d00
#define AC_VERB_PARAMETERS			0x0f00
#define AC_VERB_GET_CONNECT_SEL			0x0f01
#define AC_VERB_GET_CONNECT_LIST		0x0f02
#define AC_VERB_GET_PROC_STATE			0x0f03
#define AC_VERB_GET_SDI_SELECT			0x0f04
#define AC_VERB_GET_POWER_STATE			0x0f05
#define AC_VERB_GET_CONV			0x0f06
#define AC_VERB_GET_PIN_WIDGET_CONTROL		0x0f07
#define AC_VERB_GET_UNSOLICITED_RESPONSE	0x0f08
#define AC_VERB_GET_PIN_SENSE			0x0f09
#define AC_VERB_GET_BEEP_CONTROL		0x0f0a
#define AC_VERB_GET_EAPD_BTLENABLE		0x0f0c
#define AC_VERB_GET_DIGI_CONVERT		0x0f0d
#define AC_VERB_GET_VOLUME_KNOB_CONTROL		0x0f0f
/* f10-f1a: GPIO */
#define AC_VERB_GET_GPIO_DATA			0x0f15
#define AC_VERB_GET_GPIO_MASK			0x0f16
#define AC_VERB_GET_GPIO_DIRECTION		0x0f17
#define AC_VERB_GET_CONFIG_DEFAULT		0x0f1c
/* f20: AFG/MFG */
#define AC_VERB_GET_SUBSYSTEM_ID		0x0f20

/*
 * SET verbs
 */
#define AC_VERB_SET_STREAM_FORMAT		0x200
#define AC_VERB_SET_AMP_GAIN_MUTE		0x300
#define AC_VERB_SET_PROC_COEF			0x400
#define AC_VERB_SET_COEF_INDEX			0x500
#define AC_VERB_SET_CONNECT_SEL			0x701
#define AC_VERB_SET_PROC_STATE			0x703
#define AC_VERB_SET_SDI_SELECT			0x704
#define AC_VERB_SET_POWER_STATE			0x705
#define AC_VERB_SET_CHANNEL_STREAMID		0x706
#define AC_VERB_SET_PIN_WIDGET_CONTROL		0x707
#define AC_VERB_SET_UNSOLICITED_ENABLE		0x708
#define AC_VERB_SET_PIN_SENSE			0x709
#define AC_VERB_SET_BEEP_CONTROL		0x70a
#define AC_VERB_SET_EAPD_BTLENABLE		0x70c
#define AC_VERB_SET_DIGI_CONVERT_1		0x70d
#define AC_VERB_SET_DIGI_CONVERT_2		0x70e
#define AC_VERB_SET_VOLUME_KNOB_CONTROL		0x70f
#define AC_VERB_SET_GPIO_DATA			0x715
#define AC_VERB_SET_GPIO_MASK			0x716
#define AC_VERB_SET_GPIO_DIRECTION		0x717
#define AC_VERB_SET_CONFIG_DEFAULT_BYTES_0	0x71c
#define AC_VERB_SET_CONFIG_DEFAULT_BYTES_1	0x71d
#define AC_VERB_SET_CONFIG_DEFAULT_BYTES_2	0x71e
#define AC_VERB_SET_CONFIG_DEFAULT_BYTES_3	0x71f
#define AC_VERB_SET_CODEC_RESET			0x7ff

/*
 * Parameter IDs
 */
#define AC_PAR_VENDOR_ID		0x00
#define AC_PAR_SUBSYSTEM_ID		0x01
#define AC_PAR_REV_ID			0x02
#define AC_PAR_NODE_COUNT		0x04
#define AC_PAR_FUNCTION_TYPE		0x05
#define AC_PAR_AUDIO_FG_CAP		0x08
#define AC_PAR_AUDIO_WIDGET_CAP		0x09
#define AC_PAR_PCM			0x0a
#define AC_PAR_STREAM			0x0b
#define AC_PAR_PIN_CAP			0x0c
#define AC_PAR_AMP_IN_CAP		0x0d
#define AC_PAR_CONNLIST_LEN		0x0e
#define AC_PAR_POWER_STATE		0x0f
#define AC_PAR_PROC_CAP			0x10
#define AC_PAR_GPIO_CAP			0x11
#define AC_PAR_AMP_OUT_CAP		0x12

/*
 * AC_VERB_PARAMETERS results (32bit)
 */

/* Function Group Type */
#define AC_FGT_TYPE			(0xff<<0)
#define AC_FGT_TYPE_SHIFT		0
#define AC_FGT_UNSOL_CAP		(1<<8)

/* Audio Function Group Capabilities */
#define AC_AFG_OUT_DELAY		(0xf<<0)
#define AC_AFG_IN_DELAY			(0xf<<8)
#define AC_AFG_BEEP_GEN			(1<<16)

/* Audio Widget Capabilities */
#define AC_WCAP_STEREO			(1<<0)	/* stereo I/O */
#define AC_WCAP_IN_AMP			(1<<1)	/* AMP-in present */
#define AC_WCAP_OUT_AMP			(1<<2)	/* AMP-out present */
#define AC_WCAP_AMP_OVRD		(1<<3)	/* AMP-parameter override */
#define AC_WCAP_FORMAT_OVRD		(1<<4)	/* format override */
#define AC_WCAP_STRIPE			(1<<5)	/* stripe */
#define AC_WCAP_PROC_WID		(1<<6)	/* Proc Widget */
#define AC_WCAP_UNSOL_CAP		(1<<7)	/* Unsol capable */
#define AC_WCAP_CONN_LIST		(1<<8)	/* connection list */
#define AC_WCAP_DIGITAL			(1<<9)	/* digital I/O */
#define AC_WCAP_POWER			(1<<10)	/* power control */
#define AC_WCAP_LR_SWAP			(1<<11)	/* L/R swap */
#define AC_WCAP_DELAY			(0xf<<16)
#define AC_WCAP_DELAY_SHIFT		16
#define AC_WCAP_TYPE			(0xf<<20)
#define AC_WCAP_TYPE_SHIFT		20

/* supported PCM rates and bits */
#define AC_SUPPCM_RATES			(0xfff << 0)
#define AC_SUPPCM_BITS_8		(1<<16)
#define AC_SUPPCM_BITS_16		(1<<17)
#define AC_SUPPCM_BITS_20		(1<<18)
#define AC_SUPPCM_BITS_24		(1<<19)
#define AC_SUPPCM_BITS_32		(1<<20)

/* supported PCM stream format */
#define AC_SUPFMT_PCM			(1<<0)
#define AC_SUPFMT_FLOAT32		(1<<1)
#define AC_SUPFMT_AC3			(1<<2)

/* Pin widget capabilies */
#define AC_PINCAP_IMP_SENSE		(1<<0)	/* impedance sense capable */
#define AC_PINCAP_TRIG_REQ		(1<<1)	/* trigger required */
#define AC_PINCAP_PRES_DETECT		(1<<2)	/* presence detect capable */
#define AC_PINCAP_HP_DRV		(1<<3)	/* headphone drive capable */
#define AC_PINCAP_OUT			(1<<4)	/* output capable */
#define AC_PINCAP_IN			(1<<5)	/* input capable */
#define AC_PINCAP_BALANCE		(1<<6)	/* balanced I/O capable */
#define AC_PINCAP_VREF			(0x37<<8)
#define AC_PINCAP_VREF_SHIFT		8
#define AC_PINCAP_EAPD			(1<<16)	/* EAPD capable */
/* Vref status (used in pin cap) */
#define AC_PINCAP_VREF_HIZ		(1<<0)	/* Hi-Z */
#define AC_PINCAP_VREF_50		(1<<1)	/* 50% */
#define AC_PINCAP_VREF_GRD		(1<<2)	/* ground */
#define AC_PINCAP_VREF_80		(1<<4)	/* 80% */
#define AC_PINCAP_VREF_100		(1<<5)	/* 100% */

/* Amplifier capabilities */
#define AC_AMPCAP_OFFSET		(0x7f<<0)  /* 0dB offset */
#define AC_AMPCAP_OFFSET_SHIFT		0
#define AC_AMPCAP_NUM_STEPS		(0x7f<<8)  /* number of steps */
#define AC_AMPCAP_NUM_STEPS_SHIFT	8
#define AC_AMPCAP_STEP_SIZE		(0x7f<<16) /* step size 0-32dB
						    * in 0.25dB
						    */
#define AC_AMPCAP_STEP_SIZE_SHIFT	16
#define AC_AMPCAP_MUTE			(1<<31)    /* mute capable */
#define AC_AMPCAP_MUTE_SHIFT		31

/* Connection list */
#define AC_CLIST_LENGTH			(0x7f<<0)
#define AC_CLIST_LONG			(1<<7)

/* Supported power status */
#define AC_PWRST_D0SUP			(1<<0)
#define AC_PWRST_D1SUP			(1<<1)
#define AC_PWRST_D2SUP			(1<<2)
#define AC_PWRST_D3SUP			(1<<3)

/* Power state values */
#define AC_PWRST_D0			0x00
#define AC_PWRST_D1			0x01
#define AC_PWRST_D2			0x02
#define AC_PWRST_D3			0x03

/* Processing capabilies */
#define AC_PCAP_BENIGN			(1<<0)
#define AC_PCAP_NUM_COEF		(0xff<<8)

/* Volume knobs capabilities */
#define AC_KNBCAP_NUM_STEPS		(0x7f<<0)
#define AC_KNBCAP_DELTA			(1<<8)

/*
 * Control Parameters
 */

/* Amp gain/mute */
#define AC_AMP_MUTE			(1<<7)
#define AC_AMP_GAIN			(0x7f)
#define AC_AMP_GET_INDEX		(0xf<<0)

#define AC_AMP_GET_LEFT			(1<<13)
#define AC_AMP_GET_RIGHT		(0<<13)
#define AC_AMP_GET_OUTPUT		(1<<15)
#define AC_AMP_GET_INPUT		(0<<15)

#define AC_AMP_SET_INDEX		(0xf<<8)
#define AC_AMP_SET_INDEX_SHIFT		8
#define AC_AMP_SET_RIGHT		(1<<12)
#define AC_AMP_SET_LEFT			(1<<13)
#define AC_AMP_SET_INPUT		(1<<14)
#define AC_AMP_SET_OUTPUT		(1<<15)

/* DIGITAL1 bits */
#define AC_DIG1_ENABLE			(1<<0)
#define AC_DIG1_V			(1<<1)
#define AC_DIG1_VCFG			(1<<2)
#define AC_DIG1_EMPHASIS		(1<<3)
#define AC_DIG1_COPYRIGHT		(1<<4)
#define AC_DIG1_NONAUDIO		(1<<5)
#define AC_DIG1_PROFESSIONAL		(1<<6)
#define AC_DIG1_LEVEL			(1<<7)

/* Pin widget control - 8bit */
#define AC_PINCTL_VREFEN		(0x7<<0)
#define AC_PINCTL_VREF_HIZ		0	/* Hi-Z */
#define AC_PINCTL_VREF_50		1	/* 50% */
#define AC_PINCTL_VREF_GRD		2	/* ground */
#define AC_PINCTL_VREF_80		4	/* 80% */
#define AC_PINCTL_VREF_100		5	/* 100% */
#define AC_PINCTL_IN_EN			(1<<5)
#define AC_PINCTL_OUT_EN		(1<<6)
#define AC_PINCTL_HP_EN			(1<<7)

/* Unsolicited response - 8bit */
#define AC_USRSP_EN			(1<<7)

/* configuration default - 32bit */
#define AC_DEFCFG_SEQUENCE		(0xf<<0)
#define AC_DEFCFG_DEF_ASSOC		(0xf<<4)
#define AC_DEFCFG_ASSOC_SHIFT		4
#define AC_DEFCFG_MISC			(0xf<<8)
#define AC_DEFCFG_MISC_SHIFT		8
#define AC_DEFCFG_COLOR			(0xf<<12)
#define AC_DEFCFG_COLOR_SHIFT		12
#define AC_DEFCFG_CONN_TYPE		(0xf<<16)
#define AC_DEFCFG_CONN_TYPE_SHIFT	16
#define AC_DEFCFG_DEVICE		(0xf<<20)
#define AC_DEFCFG_DEVICE_SHIFT		20
#define AC_DEFCFG_LOCATION		(0x3f<<24)
#define AC_DEFCFG_LOCATION_SHIFT	24
#define AC_DEFCFG_PORT_CONN		(0x3<<30)
#define AC_DEFCFG_PORT_CONN_SHIFT	30

/* device device types (0x0-0xf) */
enum {
	AC_JACK_LINE_OUT,
	AC_JACK_SPEAKER,
	AC_JACK_HP_OUT,
	AC_JACK_CD,
	AC_JACK_SPDIF_OUT,
	AC_JACK_DIG_OTHER_OUT,
	AC_JACK_MODEM_LINE_SIDE,
	AC_JACK_MODEM_HAND_SIDE,
	AC_JACK_LINE_IN,
	AC_JACK_AUX,
	AC_JACK_MIC_IN,
	AC_JACK_TELEPHONY,
	AC_JACK_SPDIF_IN,
	AC_JACK_DIG_OTHER_IN,
	AC_JACK_OTHER = 0xf,
};

/* jack connection types (0x0-0xf) */
enum {
	AC_JACK_CONN_UNKNOWN,
	AC_JACK_CONN_1_8,
	AC_JACK_CONN_1_4,
	AC_JACK_CONN_ATAPI,
	AC_JACK_CONN_RCA,
	AC_JACK_CONN_OPTICAL,
	AC_JACK_CONN_OTHER_DIGITAL,
	AC_JACK_CONN_OTHER_ANALOG,
	AC_JACK_CONN_DIN,
	AC_JACK_CONN_XLR,
	AC_JACK_CONN_RJ11,
	AC_JACK_CONN_COMB,
	AC_JACK_CONN_OTHER = 0xf,
};

/* jack colors (0x0-0xf) */
enum {
	AC_JACK_COLOR_UNKNOWN,
	AC_JACK_COLOR_BLACK,
	AC_JACK_COLOR_GREY,
	AC_JACK_COLOR_BLUE,
	AC_JACK_COLOR_GREEN,
	AC_JACK_COLOR_RED,
	AC_JACK_COLOR_ORANGE,
	AC_JACK_COLOR_YELLOW,
	AC_JACK_COLOR_PURPLE,
	AC_JACK_COLOR_PINK,
	AC_JACK_COLOR_WHITE = 0xe,
	AC_JACK_COLOR_OTHER,
};

/* Jack location (0x0-0x3f) */
/* common case */
enum {
	AC_JACK_LOC_NONE,
	AC_JACK_LOC_REAR,
	AC_JACK_LOC_FRONT,
	AC_JACK_LOC_LEFT,
	AC_JACK_LOC_RIGHT,
	AC_JACK_LOC_TOP,
	AC_JACK_LOC_BOTTOM,
};
/* bits 4-5 */
enum {
	AC_JACK_LOC_EXTERNAL = 0x00,
	AC_JACK_LOC_INTERNAL = 0x10,
	AC_JACK_LOC_SEPARATE = 0x20,
	AC_JACK_LOC_OTHER    = 0x30,
};
enum {
	/* external on primary chasis */
	AC_JACK_LOC_REAR_PANEL = 0x07,
	AC_JACK_LOC_DRIVE_BAY,
	/* internal */
	AC_JACK_LOC_RISER = 0x17,
	AC_JACK_LOC_HDMI,
	AC_JACK_LOC_ATAPI,
	/* others */
	AC_JACK_LOC_MOBILE_IN = 0x37,
	AC_JACK_LOC_MOBILE_OUT,
};

/* Port connectivity (0-3) */
enum {
	AC_JACK_PORT_COMPLEX,
	AC_JACK_PORT_NONE,
	AC_JACK_PORT_FIXED,
	AC_JACK_PORT_BOTH,
};

/* max. connections to a widget */
#define HDA_MAX_CONNECTIONS	32

/* max. codec address */
#define HDA_MAX_CODEC_ADDRESS	0x0f

/*
 * Structures
 */

struct hda_bus;
struct hda_codec;
struct hda_pcm;
struct hda_pcm_stream;
struct hda_bus_unsolicited;

/* NID type */
typedef u16 hda_nid_t;

/* bus operators */
struct hda_bus_ops {
	/* send a single command */
	int (*command)(struct hda_codec *codec, hda_nid_t nid, int direct,
		       unsigned int verb, unsigned int parm);
	/* get a response from the last command */
	unsigned int (*get_response)(struct hda_codec *codec);
	/* free the private data */
	void (*private_free)(struct hda_bus *);
};

/* template to pass to the bus constructor */
struct hda_bus_template {
	void *private_data;
	struct pci_dev *pci;
	const char *modelname;
	struct hda_bus_ops ops;
};

/*
 * codec bus
 *
 * each controller needs to creata a hda_bus to assign the accessor.
 * A hda_bus contains several codecs in the list codec_list.
 */
struct hda_bus {
	struct snd_card *card;

	/* copied from template */
	void *private_data;
	struct pci_dev *pci;
	const char *modelname;
	struct hda_bus_ops ops;

	/* codec linked list */
	struct list_head codec_list;
	/* link caddr -> codec */
	struct hda_codec *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];

	struct mutex cmd_mutex;

	/* unsolicited event queue */
	struct hda_bus_unsolicited *unsol;

	struct snd_info_entry *proc;
};

/*
 * codec preset
 *
 * Known codecs have the patch to build and set up the controls/PCMs
 * better than the generic parser.
 */
struct hda_codec_preset {
	unsigned int id;
	unsigned int mask;
	unsigned int subs;
	unsigned int subs_mask;
	unsigned int rev;
	const char *name;
	int (*patch)(struct hda_codec *codec);
};
	
/* ops set by the preset patch */
struct hda_codec_ops {
	int (*build_controls)(struct hda_codec *codec);
	int (*build_pcms)(struct hda_codec *codec);
	int (*init)(struct hda_codec *codec);
	void (*free)(struct hda_codec *codec);
	void (*unsol_event)(struct hda_codec *codec, unsigned int res);
#ifdef CONFIG_PM
	int (*suspend)(struct hda_codec *codec, pm_message_t state);
	int (*resume)(struct hda_codec *codec);
#endif
};

/* record for amp information cache */
struct hda_cache_head {
	u32 key;		/* hash key */
	u16 val;		/* assigned value */
	u16 next;		/* next link; -1 = terminal */
};

struct hda_amp_info {
	struct hda_cache_head head;
	u32 amp_caps;		/* amp capabilities */
	u16 vol[2];		/* current volume & mute */
};

struct hda_cache_rec {
	u16 hash[64];			/* hash table for index */
	unsigned int num_entries;	/* number of assigned entries */
	unsigned int size;		/* allocated size */
	unsigned int record_size;	/* record size (including header) */
	void *buffer;			/* hash table entries */
};

/* PCM callbacks */
struct hda_pcm_ops {
	int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
		    struct snd_pcm_substream *substream);
	int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
		     struct snd_pcm_substream *substream);
	int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
		       unsigned int stream_tag, unsigned int format,
		       struct snd_pcm_substream *substream);
	int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
		       struct snd_pcm_substream *substream);
};

/* PCM information for each substream */
struct hda_pcm_stream {
	unsigned int substreams;	/* number of substreams, 0 = not exist*/
	unsigned int channels_min;	/* min. number of channels */
	unsigned int channels_max;	/* max. number of channels */
	hda_nid_t nid;	/* default NID to query rates/formats/bps, or set up */
	u32 rates;	/* supported rates */
	u64 formats;	/* supported formats (SNDRV_PCM_FMTBIT_) */
	unsigned int maxbps;	/* supported max. bit per sample */
	struct hda_pcm_ops ops;
};

/* for PCM creation */
struct hda_pcm {
	char *name;
	struct hda_pcm_stream stream[2];
	unsigned int is_modem;	/* modem codec? */
};

/* codec information */
struct hda_codec {
	struct hda_bus *bus;
	unsigned int addr;	/* codec addr*/
	struct list_head list;	/* list point */

	hda_nid_t afg;	/* AFG node id */
	hda_nid_t mfg;	/* MFG node id */

	/* ids */
	u32 vendor_id;
	u32 subsystem_id;
	u32 revision_id;

	/* detected preset */
	const struct hda_codec_preset *preset;

	/* set by patch */
	struct hda_codec_ops patch_ops;

	/* resume phase - all controls should update even if
	 * the values are not changed
	 */
	unsigned int in_resume;

	/* PCM to create, set by patch_ops.build_pcms callback */
	unsigned int num_pcms;
	struct hda_pcm *pcm_info;

	/* codec specific info */
	void *spec;

	/* widget capabilities cache */
	unsigned int num_nodes;
	hda_nid_t start_nid;
	u32 *wcaps;

	struct hda_cache_rec amp_cache;	/* cache for amp access */
	struct hda_cache_rec cmd_cache;	/* cache for other commands */

	struct mutex spdif_mutex;
	unsigned int spdif_status;	/* IEC958 status bits */
	unsigned short spdif_ctls;	/* SPDIF control bits */
	unsigned int spdif_in_enable;	/* SPDIF input enable? */

	struct snd_hwdep *hwdep;	/* assigned hwdep device */
};

/* direction */
enum {
	HDA_INPUT, HDA_OUTPUT
};


/*
 * constructors
 */
int snd_hda_bus_new(struct snd_card *card, const struct hda_bus_template *temp,
		    struct hda_bus **busp);
int snd_hda_codec_new(struct hda_bus *bus, unsigned int codec_addr,
		      struct hda_codec **codecp);

/*
 * low level functions
 */
unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
				int direct,
				unsigned int verb, unsigned int parm);
int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int direct,
			unsigned int verb, unsigned int parm);
#define snd_hda_param_read(codec, nid, param) \
	snd_hda_codec_read(codec, nid, 0, AC_VERB_PARAMETERS, param)
int snd_hda_get_sub_nodes(struct hda_codec *codec, hda_nid_t nid,
			  hda_nid_t *start_id);
int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
			    hda_nid_t *conn_list, int max_conns);

struct hda_verb {
	hda_nid_t nid;
	u32 verb;
	u32 param;
};

void snd_hda_sequence_write(struct hda_codec *codec,
			    const struct hda_verb *seq);

/* unsolicited event */
int snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex);

/* cached write */
int snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
			      int direct, unsigned int verb, unsigned int parm);
void snd_hda_sequence_write_cache(struct hda_codec *codec,
				  const struct hda_verb *seq);
void snd_hda_codec_resume_cache(struct hda_codec *codec);

/*
 * Mixer
 */
int snd_hda_build_controls(struct hda_bus *bus);

/*
 * PCM
 */
int snd_hda_build_pcms(struct hda_bus *bus);
void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
				u32 stream_tag,
				int channel_id, int format);
unsigned int snd_hda_calc_stream_format(unsigned int rate,
					unsigned int channels,
					unsigned int format,
					unsigned int maxbps);
int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid,
				u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid,
				unsigned int format);

/*
 * Misc
 */
void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);

/*
 * power management
 */
#ifdef CONFIG_PM
int snd_hda_suspend(struct hda_bus *bus, pm_message_t state);
int snd_hda_resume(struct hda_bus *bus);
#endif

#endif /* __SOUND_HDA_CODEC_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Universal Interface for Intel High Definition Audio Codec
	3	*
	4	* Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License as published by the Free
	8	* Software Foundation; either version 2 of the License, or (at your option)
	9	* any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful, but WITHOUT
	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	14	* more details.
	15	*
	16	* You should have received a copy of the GNU General Public License along with
	17	* this program; if not, write to the Free Software Foundation, Inc., 59
	18	* Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	19	*/
	20
	21	#ifndef __SOUND_HDA_CODEC_H
	22	#define __SOUND_HDA_CODEC_H
	23
	24	#include <sound/info.h>
	25	#include <sound/control.h>
	26	#include <sound/pcm.h>
2807314d	27	#include <sound/hwdep.h>
1da177e4 LT	28
	29	/*
	30	* nodes
	31	*/
	32	#define AC_NODE_ROOT 0x00
	33
	34	/*
	35	* function group types
	36	*/
	37	enum {
	38	AC_GRP_AUDIO_FUNCTION = 0x01,
	39	AC_GRP_MODEM_FUNCTION = 0x02,
	40	};
	41
	42	/*
	43	* widget types
	44	*/
	45	enum {
	46	AC_WID_AUD_OUT, /* Audio Out */
	47	AC_WID_AUD_IN, /* Audio In */
	48	AC_WID_AUD_MIX, /* Audio Mixer */
	49	AC_WID_AUD_SEL, /* Audio Selector */
	50	AC_WID_PIN, /* Pin Complex */
	51	AC_WID_POWER, /* Power */
	52	AC_WID_VOL_KNB, /* Volume Knob */
	53	AC_WID_BEEP, /* Beep Generator */
	54	AC_WID_VENDOR = 0x0f /* Vendor specific */
	55	};
	56
	57	/*
	58	* GET verbs
	59	*/
	60	#define AC_VERB_GET_STREAM_FORMAT 0x0a00
	61	#define AC_VERB_GET_AMP_GAIN_MUTE 0x0b00
	62	#define AC_VERB_GET_PROC_COEF 0x0c00
	63	#define AC_VERB_GET_COEF_INDEX 0x0d00
	64	#define AC_VERB_PARAMETERS 0x0f00
	65	#define AC_VERB_GET_CONNECT_SEL 0x0f01
	66	#define AC_VERB_GET_CONNECT_LIST 0x0f02
	67	#define AC_VERB_GET_PROC_STATE 0x0f03
	68	#define AC_VERB_GET_SDI_SELECT 0x0f04
	69	#define AC_VERB_GET_POWER_STATE 0x0f05
	70	#define AC_VERB_GET_CONV 0x0f06
	71	#define AC_VERB_GET_PIN_WIDGET_CONTROL 0x0f07
	72	#define AC_VERB_GET_UNSOLICITED_RESPONSE 0x0f08
	73	#define AC_VERB_GET_PIN_SENSE 0x0f09
	74	#define AC_VERB_GET_BEEP_CONTROL 0x0f0a
	75	#define AC_VERB_GET_EAPD_BTLENABLE 0x0f0c
	76	#define AC_VERB_GET_DIGI_CONVERT 0x0f0d
	77	#define AC_VERB_GET_VOLUME_KNOB_CONTROL 0x0f0f
	78	/* f10-f1a: GPIO */
16ded525 TI	79	#define AC_VERB_GET_GPIO_DATA 0x0f15
	80	#define AC_VERB_GET_GPIO_MASK 0x0f16
	81	#define AC_VERB_GET_GPIO_DIRECTION 0x0f17
1da177e4	82	#define AC_VERB_GET_CONFIG_DEFAULT 0x0f1c
86284e45 TI	83	/* f20: AFG/MFG */
86284e45 TI	84	#define AC_VERB_GET_SUBSYSTEM_ID 0x0f20
1da177e4 LT	85
	86	/*
	87	* SET verbs
	88	*/
	89	#define AC_VERB_SET_STREAM_FORMAT 0x200
	90	#define AC_VERB_SET_AMP_GAIN_MUTE 0x300
	91	#define AC_VERB_SET_PROC_COEF 0x400
	92	#define AC_VERB_SET_COEF_INDEX 0x500
	93	#define AC_VERB_SET_CONNECT_SEL 0x701
	94	#define AC_VERB_SET_PROC_STATE 0x703
	95	#define AC_VERB_SET_SDI_SELECT 0x704
	96	#define AC_VERB_SET_POWER_STATE 0x705
	97	#define AC_VERB_SET_CHANNEL_STREAMID 0x706
	98	#define AC_VERB_SET_PIN_WIDGET_CONTROL 0x707
	99	#define AC_VERB_SET_UNSOLICITED_ENABLE 0x708
	100	#define AC_VERB_SET_PIN_SENSE 0x709
	101	#define AC_VERB_SET_BEEP_CONTROL 0x70a
a2a20939	102	#define AC_VERB_SET_EAPD_BTLENABLE 0x70c
1da177e4 LT	103	#define AC_VERB_SET_DIGI_CONVERT_1 0x70d
	104	#define AC_VERB_SET_DIGI_CONVERT_2 0x70e
	105	#define AC_VERB_SET_VOLUME_KNOB_CONTROL 0x70f
16ded525 TI	106	#define AC_VERB_SET_GPIO_DATA 0x715
	107	#define AC_VERB_SET_GPIO_MASK 0x716
	108	#define AC_VERB_SET_GPIO_DIRECTION 0x717
1da177e4 LT	109	#define AC_VERB_SET_CONFIG_DEFAULT_BYTES_0 0x71c
	110	#define AC_VERB_SET_CONFIG_DEFAULT_BYTES_1 0x71d
	111	#define AC_VERB_SET_CONFIG_DEFAULT_BYTES_2 0x71e
	112	#define AC_VERB_SET_CONFIG_DEFAULT_BYTES_3 0x71f
	113	#define AC_VERB_SET_CODEC_RESET 0x7ff
	114
	115	/*
	116	* Parameter IDs
	117	*/
	118	#define AC_PAR_VENDOR_ID 0x00
	119	#define AC_PAR_SUBSYSTEM_ID 0x01
	120	#define AC_PAR_REV_ID 0x02
	121	#define AC_PAR_NODE_COUNT 0x04
	122	#define AC_PAR_FUNCTION_TYPE 0x05
	123	#define AC_PAR_AUDIO_FG_CAP 0x08
	124	#define AC_PAR_AUDIO_WIDGET_CAP 0x09
	125	#define AC_PAR_PCM 0x0a
	126	#define AC_PAR_STREAM 0x0b
	127	#define AC_PAR_PIN_CAP 0x0c
	128	#define AC_PAR_AMP_IN_CAP 0x0d
	129	#define AC_PAR_CONNLIST_LEN 0x0e
	130	#define AC_PAR_POWER_STATE 0x0f
	131	#define AC_PAR_PROC_CAP 0x10
	132	#define AC_PAR_GPIO_CAP 0x11
	133	#define AC_PAR_AMP_OUT_CAP 0x12
	134
	135	/*
	136	* AC_VERB_PARAMETERS results (32bit)
	137	*/
	138
	139	/* Function Group Type */
	140	#define AC_FGT_TYPE (0xff<<0)
	141	#define AC_FGT_TYPE_SHIFT 0
	142	#define AC_FGT_UNSOL_CAP (1<<8)
	143
	144	/* Audio Function Group Capabilities */
	145	#define AC_AFG_OUT_DELAY (0xf<<0)
	146	#define AC_AFG_IN_DELAY (0xf<<8)
	147	#define AC_AFG_BEEP_GEN (1<<16)
	148
	149	/* Audio Widget Capabilities */
	150	#define AC_WCAP_STEREO (1<<0) /* stereo I/O */
	151	#define AC_WCAP_IN_AMP (1<<1) /* AMP-in present */
	152	#define AC_WCAP_OUT_AMP (1<<2) /* AMP-out present */
	153	#define AC_WCAP_AMP_OVRD (1<<3) /* AMP-parameter override */
	154	#define AC_WCAP_FORMAT_OVRD (1<<4) /* format override */
	155	#define AC_WCAP_STRIPE (1<<5) /* stripe */
	156	#define AC_WCAP_PROC_WID (1<<6) /* Proc Widget */
	157	#define AC_WCAP_UNSOL_CAP (1<<7) /* Unsol capable */
	158	#define AC_WCAP_CONN_LIST (1<<8) /* connection list */
	159	#define AC_WCAP_DIGITAL (1<<9) /* digital I/O */
	160	#define AC_WCAP_POWER (1<<10) /* power control */
	161	#define AC_WCAP_LR_SWAP (1<<11) /* L/R swap */
	162	#define AC_WCAP_DELAY (0xf<<16)
	163	#define AC_WCAP_DELAY_SHIFT 16
	164	#define AC_WCAP_TYPE (0xf<<20)
	165	#define AC_WCAP_TYPE_SHIFT 20
	166
	167	/* supported PCM rates and bits */
	168	#define AC_SUPPCM_RATES (0xfff << 0)
	169	#define AC_SUPPCM_BITS_8 (1<<16)
	170	#define AC_SUPPCM_BITS_16 (1<<17)
	171	#define AC_SUPPCM_BITS_20 (1<<18)
	172	#define AC_SUPPCM_BITS_24 (1<<19)
173	#define AC_SUPPCM_BITS_32 (1<<20)
174
175	/* supported PCM stream format */
176	#define AC_SUPFMT_PCM (1<<0)
177	#define AC_SUPFMT_FLOAT32 (1<<1)
178	#define AC_SUPFMT_AC3 (1<<2)
179
180	/* Pin widget capabilies */
181	#define AC_PINCAP_IMP_SENSE (1<<0) /* impedance sense capable */
182	#define AC_PINCAP_TRIG_REQ (1<<1) /* trigger required */
183	#define AC_PINCAP_PRES_DETECT (1<<2) /* presence detect capable */
184	#define AC_PINCAP_HP_DRV (1<<3) /* headphone drive capable */
185	#define AC_PINCAP_OUT (1<<4) /* output capable */
186	#define AC_PINCAP_IN (1<<5) /* input capable */
187	#define AC_PINCAP_BALANCE (1<<6) /* balanced I/O capable */
1a12de1e	188	#define AC_PINCAP_VREF (0x37<<8)
1da177e4 LT	189	#define AC_PINCAP_VREF_SHIFT 8
1da177e4 LT	190	#define AC_PINCAP_EAPD (1<<16) /* EAPD capable */
1a12de1e M	191	/* Vref status (used in pin cap) */
	192	#define AC_PINCAP_VREF_HIZ (1<<0) /* Hi-Z */
	193	#define AC_PINCAP_VREF_50 (1<<1) /* 50% */
	194	#define AC_PINCAP_VREF_GRD (1<<2) /* ground */
	195	#define AC_PINCAP_VREF_80 (1<<4) /* 80% */
	196	#define AC_PINCAP_VREF_100 (1<<5) /* 100% */
1da177e4 LT	197
	198	/* Amplifier capabilities */
	199	#define AC_AMPCAP_OFFSET (0x7f<<0) /* 0dB offset */
	200	#define AC_AMPCAP_OFFSET_SHIFT 0
	201	#define AC_AMPCAP_NUM_STEPS (0x7f<<8) /* number of steps */
	202	#define AC_AMPCAP_NUM_STEPS_SHIFT 8
d01ce99f TI	203	#define AC_AMPCAP_STEP_SIZE (0x7f<<16) /* step size 0-32dB
	204	* in 0.25dB
	205	*/
1da177e4 LT	206	#define AC_AMPCAP_STEP_SIZE_SHIFT 16
	207	#define AC_AMPCAP_MUTE (1<<31) /* mute capable */
	208	#define AC_AMPCAP_MUTE_SHIFT 31
	209
	210	/* Connection list */
	211	#define AC_CLIST_LENGTH (0x7f<<0)
	212	#define AC_CLIST_LONG (1<<7)
	213
	214	/* Supported power status */
	215	#define AC_PWRST_D0SUP (1<<0)
	216	#define AC_PWRST_D1SUP (1<<1)
	217	#define AC_PWRST_D2SUP (1<<2)
	218	#define AC_PWRST_D3SUP (1<<3)
	219
54d17403 TI	220	/* Power state values */
	221	#define AC_PWRST_D0 0x00
	222	#define AC_PWRST_D1 0x01
	223	#define AC_PWRST_D2 0x02
	224	#define AC_PWRST_D3 0x03
	225
1da177e4 LT	226	/* Processing capabilies */
	227	#define AC_PCAP_BENIGN (1<<0)
	228	#define AC_PCAP_NUM_COEF (0xff<<8)
	229
	230	/* Volume knobs capabilities */
	231	#define AC_KNBCAP_NUM_STEPS (0x7f<<0)
	232	#define AC_KNBCAP_DELTA (1<<8)
	233
	234	/*
	235	* Control Parameters
	236	*/
	237
	238	/* Amp gain/mute */
d427c77e	239	#define AC_AMP_MUTE (1<<7)
1da177e4 LT	240	#define AC_AMP_GAIN (0x7f)
	241	#define AC_AMP_GET_INDEX (0xf<<0)
	242
	243	#define AC_AMP_GET_LEFT (1<<13)
	244	#define AC_AMP_GET_RIGHT (0<<13)
	245	#define AC_AMP_GET_OUTPUT (1<<15)
	246	#define AC_AMP_GET_INPUT (0<<15)
	247
	248	#define AC_AMP_SET_INDEX (0xf<<8)
	249	#define AC_AMP_SET_INDEX_SHIFT 8
	250	#define AC_AMP_SET_RIGHT (1<<12)
	251	#define AC_AMP_SET_LEFT (1<<13)
	252	#define AC_AMP_SET_INPUT (1<<14)
	253	#define AC_AMP_SET_OUTPUT (1<<15)
	254
	255	/* DIGITAL1 bits */
	256	#define AC_DIG1_ENABLE (1<<0)
	257	#define AC_DIG1_V (1<<1)
	258	#define AC_DIG1_VCFG (1<<2)
	259	#define AC_DIG1_EMPHASIS (1<<3)
	260	#define AC_DIG1_COPYRIGHT (1<<4)
	261	#define AC_DIG1_NONAUDIO (1<<5)
	262	#define AC_DIG1_PROFESSIONAL (1<<6)
	263	#define AC_DIG1_LEVEL (1<<7)
	264
	265	/* Pin widget control - 8bit */
	266	#define AC_PINCTL_VREFEN (0x7<<0)
98f759a6 TI	267	#define AC_PINCTL_VREF_HIZ 0 /* Hi-Z */
	268	#define AC_PINCTL_VREF_50 1 /* 50% */
	269	#define AC_PINCTL_VREF_GRD 2 /* ground */
	270	#define AC_PINCTL_VREF_80 4 /* 80% */
	271	#define AC_PINCTL_VREF_100 5 /* 100% */
1da177e4 LT	272	#define AC_PINCTL_IN_EN (1<<5)
	273	#define AC_PINCTL_OUT_EN (1<<6)
	274	#define AC_PINCTL_HP_EN (1<<7)
	275
4e55096e M	276	/* Unsolicited response - 8bit */
	277	#define AC_USRSP_EN (1<<7)
	278
1da177e4 LT	279	/* configuration default - 32bit */
	280	#define AC_DEFCFG_SEQUENCE (0xf<<0)
	281	#define AC_DEFCFG_DEF_ASSOC (0xf<<4)
d21b37ea	282	#define AC_DEFCFG_ASSOC_SHIFT 4
1da177e4	283	#define AC_DEFCFG_MISC (0xf<<8)
d21b37ea	284	#define AC_DEFCFG_MISC_SHIFT 8
1da177e4 LT	285	#define AC_DEFCFG_COLOR (0xf<<12)
	286	#define AC_DEFCFG_COLOR_SHIFT 12
	287	#define AC_DEFCFG_CONN_TYPE (0xf<<16)
	288	#define AC_DEFCFG_CONN_TYPE_SHIFT 16
	289	#define AC_DEFCFG_DEVICE (0xf<<20)
	290	#define AC_DEFCFG_DEVICE_SHIFT 20
	291	#define AC_DEFCFG_LOCATION (0x3f<<24)
	292	#define AC_DEFCFG_LOCATION_SHIFT 24
	293	#define AC_DEFCFG_PORT_CONN (0x3<<30)
	294	#define AC_DEFCFG_PORT_CONN_SHIFT 30
	295
	296	/* device device types (0x0-0xf) */
	297	enum {
	298	AC_JACK_LINE_OUT,
	299	AC_JACK_SPEAKER,
	300	AC_JACK_HP_OUT,
	301	AC_JACK_CD,
	302	AC_JACK_SPDIF_OUT,
	303	AC_JACK_DIG_OTHER_OUT,
	304	AC_JACK_MODEM_LINE_SIDE,
	305	AC_JACK_MODEM_HAND_SIDE,
	306	AC_JACK_LINE_IN,
	307	AC_JACK_AUX,
	308	AC_JACK_MIC_IN,
	309	AC_JACK_TELEPHONY,
	310	AC_JACK_SPDIF_IN,
	311	AC_JACK_DIG_OTHER_IN,
	312	AC_JACK_OTHER = 0xf,
	313	};
	314
	315	/* jack connection types (0x0-0xf) */
	316	enum {
	317	AC_JACK_CONN_UNKNOWN,
	318	AC_JACK_CONN_1_8,
	319	AC_JACK_CONN_1_4,
	320	AC_JACK_CONN_ATAPI,
	321	AC_JACK_CONN_RCA,
	322	AC_JACK_CONN_OPTICAL,
	323	AC_JACK_CONN_OTHER_DIGITAL,
	324	AC_JACK_CONN_OTHER_ANALOG,
	325	AC_JACK_CONN_DIN,
	326	AC_JACK_CONN_XLR,
	327	AC_JACK_CONN_RJ11,
	328	AC_JACK_CONN_COMB,
	329	AC_JACK_CONN_OTHER = 0xf,
	330	};
	331
	332	/* jack colors (0x0-0xf) */
	333	enum {
	334	AC_JACK_COLOR_UNKNOWN,
	335	AC_JACK_COLOR_BLACK,
	336	AC_JACK_COLOR_GREY,
	337	AC_JACK_COLOR_BLUE,
	338	AC_JACK_COLOR_GREEN,
	339	AC_JACK_COLOR_RED,
	340	AC_JACK_COLOR_ORANGE,
	341	AC_JACK_COLOR_YELLOW,
	342	AC_JACK_COLOR_PURPLE,
	343	AC_JACK_COLOR_PINK,
	344	AC_JACK_COLOR_WHITE = 0xe,
	345	AC_JACK_COLOR_OTHER,
	346	};
	347
	348	/* Jack location (0x0-0x3f) */
349	/* common case */
350	enum {
351	AC_JACK_LOC_NONE,
352	AC_JACK_LOC_REAR,
353	AC_JACK_LOC_FRONT,
354	AC_JACK_LOC_LEFT,
355	AC_JACK_LOC_RIGHT,
356	AC_JACK_LOC_TOP,
357	AC_JACK_LOC_BOTTOM,
358	};
359	/* bits 4-5 */
360	enum {
361	AC_JACK_LOC_EXTERNAL = 0x00,
362	AC_JACK_LOC_INTERNAL = 0x10,
363	AC_JACK_LOC_SEPARATE = 0x20,
364	AC_JACK_LOC_OTHER = 0x30,
365	};
366	enum {
367	/* external on primary chasis */
368	AC_JACK_LOC_REAR_PANEL = 0x07,
369	AC_JACK_LOC_DRIVE_BAY,
370	/* internal */
371	AC_JACK_LOC_RISER = 0x17,
372	AC_JACK_LOC_HDMI,
373	AC_JACK_LOC_ATAPI,
374	/* others */
375	AC_JACK_LOC_MOBILE_IN = 0x37,
376	AC_JACK_LOC_MOBILE_OUT,
377	};
378
379	/* Port connectivity (0-3) */
380	enum {
381	AC_JACK_PORT_COMPLEX,
382	AC_JACK_PORT_NONE,
383	AC_JACK_PORT_FIXED,
384	AC_JACK_PORT_BOTH,
385	};
386
387	/* max. connections to a widget */
54d17403	388	#define HDA_MAX_CONNECTIONS 32
1da177e4 LT	389
	390	/* max. codec address */
	391	#define HDA_MAX_CODEC_ADDRESS 0x0f
	392
	393	/*
	394	* Structures
	395	*/
	396
	397	struct hda_bus;
	398	struct hda_codec;
	399	struct hda_pcm;
	400	struct hda_pcm_stream;
	401	struct hda_bus_unsolicited;
	402
	403	/* NID type */
	404	typedef u16 hda_nid_t;
	405
	406	/* bus operators */
	407	struct hda_bus_ops {
	408	/* send a single command */
	409	int (command)(struct hda_codec codec, hda_nid_t nid, int direct,
	410	unsigned int verb, unsigned int parm);
	411	/* get a response from the last command */
	412	unsigned int (get_response)(struct hda_codec codec);
	413	/* free the private data */
	414	void (private_free)(struct hda_bus );
	415	};
	416
	417	/* template to pass to the bus constructor */
	418	struct hda_bus_template {
	419	void *private_data;
	420	struct pci_dev *pci;
	421	const char *modelname;
	422	struct hda_bus_ops ops;
	423	};
	424
	425	/*
	426	* codec bus
	427	*
	428	* each controller needs to creata a hda_bus to assign the accessor.
	429	* A hda_bus contains several codecs in the list codec_list.
	430	*/
	431	struct hda_bus {
c8b6bf9b	432	struct snd_card *card;
1da177e4 LT	433
	434	/* copied from template */
	435	void *private_data;
	436	struct pci_dev *pci;
	437	const char *modelname;
	438	struct hda_bus_ops ops;
	439
	440	/* codec linked list */
	441	struct list_head codec_list;
d01ce99f TI	442	/* link caddr -> codec */
d01ce99f TI	443	struct hda_codec *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
1da177e4	444
62932df8	445	struct mutex cmd_mutex;
1da177e4 LT	446
	447	/* unsolicited event queue */
	448	struct hda_bus_unsolicited *unsol;
	449
c8b6bf9b	450	struct snd_info_entry *proc;
1da177e4 LT	451	};
	452
	453	/*
	454	* codec preset
	455	*
	456	* Known codecs have the patch to build and set up the controls/PCMs
	457	* better than the generic parser.
	458	*/
	459	struct hda_codec_preset {
	460	unsigned int id;
	461	unsigned int mask;
	462	unsigned int subs;
	463	unsigned int subs_mask;
	464	unsigned int rev;
	465	const char *name;
	466	int (patch)(struct hda_codec codec);
	467	};
	468
	469	/* ops set by the preset patch */
	470	struct hda_codec_ops {
	471	int (build_controls)(struct hda_codec codec);
	472	int (build_pcms)(struct hda_codec codec);
	473	int (init)(struct hda_codec codec);
	474	void (free)(struct hda_codec codec);
	475	void (unsol_event)(struct hda_codec codec, unsigned int res);
	476	#ifdef CONFIG_PM
	477	int (suspend)(struct hda_codec codec, pm_message_t state);
	478	int (resume)(struct hda_codec codec);
	479	#endif
	480	};
	481
	482	/* record for amp information cache */
01751f54	483	struct hda_cache_head {
1da177e4	484	u32 key; /* hash key */
01751f54 TI	485	u16 val; /* assigned value */
	486	u16 next; /* next link; -1 = terminal */
	487	};
	488
	489	struct hda_amp_info {
	490	struct hda_cache_head head;
1da177e4	491	u32 amp_caps; /* amp capabilities */
7f0e2f8b	492	u16 vol[2]; /* current volume & mute */
01751f54 TI	493	};
	494
	495	struct hda_cache_rec {
	496	u16 hash[64]; /* hash table for index */
	497	unsigned int num_entries; /* number of assigned entries */
	498	unsigned int size; /* allocated size */
	499	unsigned int record_size; /* record size (including header) */
	500	void buffer; / hash table entries */
1da177e4 LT	501	};
	502
	503	/* PCM callbacks */
	504	struct hda_pcm_ops {
	505	int (open)(struct hda_pcm_stream info, struct hda_codec *codec,
c8b6bf9b	506	struct snd_pcm_substream *substream);
1da177e4	507	int (close)(struct hda_pcm_stream info, struct hda_codec *codec,
c8b6bf9b	508	struct snd_pcm_substream *substream);
1da177e4 LT	509	int (prepare)(struct hda_pcm_stream info, struct hda_codec *codec,
1da177e4 LT	510	unsigned int stream_tag, unsigned int format,
c8b6bf9b	511	struct snd_pcm_substream *substream);
1da177e4	512	int (cleanup)(struct hda_pcm_stream info, struct hda_codec *codec,
c8b6bf9b	513	struct snd_pcm_substream *substream);
1da177e4 LT	514	};
	515
	516	/* PCM information for each substream */
	517	struct hda_pcm_stream {
d01ce99f	518	unsigned int substreams; /* number of substreams, 0 = not exist*/
1da177e4 LT	519	unsigned int channels_min; /* min. number of channels */
	520	unsigned int channels_max; /* max. number of channels */
	521	hda_nid_t nid; /* default NID to query rates/formats/bps, or set up */
	522	u32 rates; /* supported rates */
	523	u64 formats; /* supported formats (SNDRV_PCM_FMTBIT_) */
	524	unsigned int maxbps; /* supported max. bit per sample */
	525	struct hda_pcm_ops ops;
	526	};
	527
	528	/* for PCM creation */
	529	struct hda_pcm {
	530	char *name;
	531	struct hda_pcm_stream stream[2];
ec9e1c5c	532	unsigned int is_modem; /* modem codec? */
1da177e4 LT	533	};
	534
	535	/* codec information */
	536	struct hda_codec {
	537	struct hda_bus *bus;
	538	unsigned int addr; /* codec addr*/
	539	struct list_head list; /* list point */
	540
	541	hda_nid_t afg; /* AFG node id */
673b683a	542	hda_nid_t mfg; /* MFG node id */
1da177e4 LT	543
	544	/* ids */
	545	u32 vendor_id;
	546	u32 subsystem_id;
	547	u32 revision_id;
	548
	549	/* detected preset */
	550	const struct hda_codec_preset *preset;
	551
	552	/* set by patch */
	553	struct hda_codec_ops patch_ops;
	554
	555	/* resume phase - all controls should update even if
	556	* the values are not changed
	557	*/
	558	unsigned int in_resume;
	559
	560	/* PCM to create, set by patch_ops.build_pcms callback */
	561	unsigned int num_pcms;
	562	struct hda_pcm *pcm_info;
	563
	564	/* codec specific info */
	565	void *spec;
	566
54d17403 TI	567	/* widget capabilities cache */
	568	unsigned int num_nodes;
	569	hda_nid_t start_nid;
	570	u32 *wcaps;
	571
01751f54	572	struct hda_cache_rec amp_cache; /* cache for amp access */
b3ac5636	573	struct hda_cache_rec cmd_cache; /* cache for other commands */
1da177e4	574
62932df8	575	struct mutex spdif_mutex;
1da177e4 LT	576	unsigned int spdif_status; /* IEC958 status bits */
	577	unsigned short spdif_ctls; /* SPDIF control bits */
	578	unsigned int spdif_in_enable; /* SPDIF input enable? */
2807314d TI	579
2807314d TI	580	struct snd_hwdep hwdep; / assigned hwdep device */
1da177e4 LT	581	};
	582
	583	/* direction */
	584	enum {
	585	HDA_INPUT, HDA_OUTPUT
	586	};
	587
	588
	589	/*
	590	* constructors
	591	*/
c8b6bf9b	592	int snd_hda_bus_new(struct snd_card card, const struct hda_bus_template temp,
1da177e4 LT	593	struct hda_bus **busp);
	594	int snd_hda_codec_new(struct hda_bus *bus, unsigned int codec_addr,
	595	struct hda_codec **codecp);
	596
	597	/*
	598	* low level functions
	599	*/
d01ce99f TI	600	unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
d01ce99f TI	601	int direct,
1da177e4 LT	602	unsigned int verb, unsigned int parm);
	603	int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int direct,
	604	unsigned int verb, unsigned int parm);
d01ce99f TI	605	#define snd_hda_param_read(codec, nid, param) \
	606	snd_hda_codec_read(codec, nid, 0, AC_VERB_PARAMETERS, param)
	607	int snd_hda_get_sub_nodes(struct hda_codec *codec, hda_nid_t nid,
	608	hda_nid_t *start_id);
	609	int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
	610	hda_nid_t *conn_list, int max_conns);
1da177e4 LT	611
	612	struct hda_verb {
	613	hda_nid_t nid;
	614	u32 verb;
	615	u32 param;
	616	};
	617
d01ce99f TI	618	void snd_hda_sequence_write(struct hda_codec *codec,
d01ce99f TI	619	const struct hda_verb *seq);
1da177e4 LT	620
	621	/* unsolicited event */
	622	int snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex);
	623
b3ac5636 TI	624	/* cached write */
	625	int snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
	626	int direct, unsigned int verb, unsigned int parm);
	627	void snd_hda_sequence_write_cache(struct hda_codec *codec,
	628	const struct hda_verb *seq);
	629	void snd_hda_codec_resume_cache(struct hda_codec *codec);
	630
1da177e4 LT	631	/*
	632	* Mixer
	633	*/
	634	int snd_hda_build_controls(struct hda_bus *bus);
	635
	636	/*
	637	* PCM
	638	*/
	639	int snd_hda_build_pcms(struct hda_bus *bus);
d01ce99f TI	640	void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
d01ce99f TI	641	u32 stream_tag,
1da177e4	642	int channel_id, int format);
d01ce99f TI	643	unsigned int snd_hda_calc_stream_format(unsigned int rate,
	644	unsigned int channels,
	645	unsigned int format,
	646	unsigned int maxbps);
1da177e4 LT	647	int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid,
	648	u32 ratesp, u64 formatsp, unsigned int *bpsp);
	649	int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid,
	650	unsigned int format);
	651
	652	/*
	653	* Misc
	654	*/
	655	void snd_hda_get_codec_name(struct hda_codec codec, char name, int namelen);
	656
	657	/*
	658	* power management
	659	*/
	660	#ifdef CONFIG_PM
	661	int snd_hda_suspend(struct hda_bus *bus, pm_message_t state);
	662	int snd_hda_resume(struct hda_bus *bus);
	663	#endif
	664
	665	#endif /* __SOUND_HDA_CODEC_H */