[linux-2.6-block.git] / include / sound / ac97_codec.h

#ifndef __SOUND_AC97_CODEC_H
#define __SOUND_AC97_CODEC_H

/*
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
 *  Universal interface for Audio Codec '97
 *
 *  For more details look to AC '97 component specification revision 2.1
 *  by Intel Corporation (http://developer.intel.com).
 *
 *
 *   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
 *
 */

#include <linux/bitops.h>
#include <linux/device.h>
#include <linux/workqueue.h>
#include <sound/ac97/regs.h>
#include <sound/pcm.h>
#include <sound/control.h>
#include <sound/info.h>

/* maximum number of devices on the AC97 bus */
#define	AC97_BUS_MAX_DEVICES	4

/* specific - SigmaTel */
#define AC97_SIGMATEL_OUTSEL	0x64	/* Output Select, STAC9758 */
#define AC97_SIGMATEL_INSEL	0x66	/* Input Select, STAC9758 */
#define AC97_SIGMATEL_IOMISC	0x68	/* STAC9758 */
#define AC97_SIGMATEL_ANALOG	0x6c	/* Analog Special */
#define AC97_SIGMATEL_DAC2INVERT 0x6e
#define AC97_SIGMATEL_BIAS1	0x70
#define AC97_SIGMATEL_BIAS2	0x72
#define AC97_SIGMATEL_VARIOUS	0x72	/* STAC9758 */
#define AC97_SIGMATEL_MULTICHN	0x74	/* Multi-Channel programming */
#define AC97_SIGMATEL_CIC1	0x76
#define AC97_SIGMATEL_CIC2	0x78

/* specific - Analog Devices */
#define AC97_AD_TEST		0x5a	/* test register */
#define AC97_AD_TEST2		0x5c	/* undocumented test register 2 */
#define AC97_AD_HPFD_SHIFT	12	/* High Pass Filter Disable */
#define AC97_AD_CODEC_CFG	0x70	/* codec configuration */
#define AC97_AD_JACK_SPDIF	0x72	/* Jack Sense & S/PDIF */
#define AC97_AD_SERIAL_CFG	0x74	/* Serial Configuration */
#define AC97_AD_MISC		0x76	/* Misc Control Bits */
#define AC97_AD_VREFD_SHIFT	2	/* V_REFOUT Disable (AD1888) */

/* specific - Cirrus Logic */
#define AC97_CSR_ACMODE		0x5e	/* AC Mode Register */
#define AC97_CSR_MISC_CRYSTAL	0x60	/* Misc Crystal Control */
#define AC97_CSR_SPDIF		0x68	/* S/PDIF Register */
#define AC97_CSR_SERIAL		0x6a	/* Serial Port Control */
#define AC97_CSR_SPECF_ADDR	0x6c	/* Special Feature Address */
#define AC97_CSR_SPECF_DATA	0x6e	/* Special Feature Data */
#define AC97_CSR_BDI_STATUS	0x7a	/* BDI Status */

/* specific - Conexant */
#define AC97_CXR_AUDIO_MISC	0x5c
#define AC97_CXR_SPDIFEN	(1<<3)
#define AC97_CXR_COPYRGT	(1<<2)
#define AC97_CXR_SPDIF_MASK	(3<<0)
#define AC97_CXR_SPDIF_PCM	0x0
#define AC97_CXR_SPDIF_AC3	0x2

/* specific - ALC */
#define AC97_ALC650_SPDIF_INPUT_STATUS1	0x60
/* S/PDIF input status 1 bit defines */
#define AC97_ALC650_PRO             0x0001  /* Professional status */
#define AC97_ALC650_NAUDIO          0x0002  /* Non audio stream */
#define AC97_ALC650_COPY            0x0004  /* Copyright status */
#define AC97_ALC650_PRE             0x0038  /* Preemphasis status */
#define AC97_ALC650_PRE_SHIFT       3
#define AC97_ALC650_MODE            0x00C0  /* Preemphasis status */
#define AC97_ALC650_MODE_SHIFT      6
#define AC97_ALC650_CC_MASK         0x7f00  /* Category Code mask */
#define AC97_ALC650_CC_SHIFT        8
#define AC97_ALC650_L               0x8000  /* Generation Level status */

#define AC97_ALC650_SPDIF_INPUT_STATUS2	0x62
/* S/PDIF input status 2 bit defines */
#define AC97_ALC650_SOUCE_MASK      0x000f  /* Source number */
#define AC97_ALC650_CHANNEL_MASK    0x00f0  /* Channel number */
#define AC97_ALC650_CHANNEL_SHIFT   4 
#define AC97_ALC650_SPSR_MASK       0x0f00  /* S/PDIF Sample Rate bits */
#define AC97_ALC650_SPSR_SHIFT      8
#define AC97_ALC650_SPSR_44K        0x0000  /* Use 44.1kHz Sample rate */
#define AC97_ALC650_SPSR_48K        0x0200  /* Use 48kHz Sample rate */
#define AC97_ALC650_SPSR_32K        0x0300  /* Use 32kHz Sample rate */
#define AC97_ALC650_CLOCK_ACCURACY  0x3000  /* Clock accuracy */
#define AC97_ALC650_CLOCK_SHIFT     12
#define AC97_ALC650_CLOCK_LOCK      0x4000  /* Clock locked status */
#define AC97_ALC650_V               0x8000  /* Validity status */

#define AC97_ALC650_SURR_DAC_VOL	0x64
#define AC97_ALC650_LFE_DAC_VOL		0x66
#define AC97_ALC650_UNKNOWN1		0x68
#define AC97_ALC650_MULTICH		0x6a
#define AC97_ALC650_UNKNOWN2		0x6c
#define AC97_ALC650_REVISION		0x6e
#define AC97_ALC650_UNKNOWN3		0x70
#define AC97_ALC650_UNKNOWN4		0x72
#define AC97_ALC650_MISC		0x74
#define AC97_ALC650_GPIO_SETUP		0x76
#define AC97_ALC650_GPIO_STATUS		0x78
#define AC97_ALC650_CLOCK		0x7a

/* specific - Yamaha YMF7x3 */
#define AC97_YMF7X3_DIT_CTRL	0x66	/* DIT Control (YMF743) / 2 (YMF753) */
#define AC97_YMF7X3_3D_MODE_SEL	0x68	/* 3D Mode Select */

/* specific - C-Media */
#define AC97_CM9738_VENDOR_CTRL	0x5a
#define AC97_CM9739_MULTI_CHAN	0x64
#define AC97_CM9739_SPDIF_IN_STATUS	0x68 /* 32bit */
#define AC97_CM9739_SPDIF_CTRL	0x6c

/* specific - wolfson */
#define AC97_WM97XX_FMIXER_VOL  0x72
#define AC97_WM9704_RMIXER_VOL  0x74
#define AC97_WM9704_TEST        0x5a
#define AC97_WM9704_RPCM_VOL    0x70
#define AC97_WM9711_OUT3VOL     0x16


/* ac97->scaps */
#define AC97_SCAP_AUDIO		(1<<0)	/* audio codec 97 */
#define AC97_SCAP_MODEM		(1<<1)	/* modem codec 97 */
#define AC97_SCAP_SURROUND_DAC	(1<<2)	/* surround L&R DACs are present */
#define AC97_SCAP_CENTER_LFE_DAC (1<<3)	/* center and LFE DACs are present */
#define AC97_SCAP_SKIP_AUDIO	(1<<4)	/* skip audio part of codec */
#define AC97_SCAP_SKIP_MODEM	(1<<5)	/* skip modem part of codec */
#define AC97_SCAP_INDEP_SDIN	(1<<6)	/* independent SDIN */
#define AC97_SCAP_INV_EAPD	(1<<7)	/* inverted EAPD */
#define AC97_SCAP_DETECT_BY_VENDOR (1<<8) /* use vendor registers for read tests */
#define AC97_SCAP_NO_SPDIF	(1<<9)	/* don't build SPDIF controls */
#define AC97_SCAP_EAPD_LED	(1<<10)	/* EAPD as mute LED */
#define AC97_SCAP_POWER_SAVE	(1<<11)	/* capable for aggressive power-saving */

/* ac97->flags */
#define AC97_HAS_PC_BEEP	(1<<0)	/* force PC Speaker usage */
#define AC97_AD_MULTI		(1<<1)	/* Analog Devices - multi codecs */
#define AC97_CS_SPDIF		(1<<2)	/* Cirrus Logic uses funky SPDIF */
#define AC97_CX_SPDIF		(1<<3)	/* Conexant's spdif interface */
#define AC97_STEREO_MUTES	(1<<4)	/* has stereo mute bits */
#define AC97_DOUBLE_RATE	(1<<5)	/* supports double rate playback */
#define AC97_HAS_NO_MASTER_VOL	(1<<6)	/* no Master volume */
#define AC97_HAS_NO_PCM_VOL	(1<<7)	/* no PCM volume */
#define AC97_DEFAULT_POWER_OFF	(1<<8)	/* no RESET write */
#define AC97_MODEM_PATCH	(1<<9)	/* modem patch */
#define AC97_HAS_NO_REC_GAIN	(1<<10) /* no Record gain */
#define AC97_HAS_NO_PHONE	(1<<11) /* no PHONE volume */
#define AC97_HAS_NO_PC_BEEP	(1<<12) /* no PC Beep volume */
#define AC97_HAS_NO_VIDEO	(1<<13) /* no Video volume */
#define AC97_HAS_NO_CD		(1<<14) /* no CD volume */
#define AC97_HAS_NO_MIC	(1<<15) /* no MIC volume */
#define AC97_HAS_NO_TONE	(1<<16) /* no Tone volume */
#define AC97_HAS_NO_STD_PCM	(1<<17)	/* no standard AC97 PCM volume and mute */
#define AC97_HAS_NO_AUX		(1<<18) /* no standard AC97 AUX volume and mute */
#define AC97_HAS_8CH		(1<<19) /* supports 8-channel output */

/* rates indexes */
#define AC97_RATES_FRONT_DAC	0
#define AC97_RATES_SURR_DAC	1
#define AC97_RATES_LFE_DAC	2
#define AC97_RATES_ADC		3
#define AC97_RATES_MIC_ADC	4
#define AC97_RATES_SPDIF	5

#define AC97_NUM_GPIOS		16
/*
 *
 */

struct snd_ac97;
struct snd_ac97_gpio_priv;
struct snd_pcm_chmap;

struct snd_ac97_build_ops {
	int (*build_3d) (struct snd_ac97 *ac97);
	int (*build_specific) (struct snd_ac97 *ac97);
	int (*build_spdif) (struct snd_ac97 *ac97);
	int (*build_post_spdif) (struct snd_ac97 *ac97);
#ifdef CONFIG_PM
	void (*suspend) (struct snd_ac97 *ac97);
	void (*resume) (struct snd_ac97 *ac97);
#endif
	void (*update_jacks) (struct snd_ac97 *ac97);	/* for jack-sharing */
};

struct snd_ac97_bus_ops {
	void (*reset) (struct snd_ac97 *ac97);
	void (*warm_reset)(struct snd_ac97 *ac97);
	void (*write) (struct snd_ac97 *ac97, unsigned short reg, unsigned short val);
	unsigned short (*read) (struct snd_ac97 *ac97, unsigned short reg);
	void (*wait) (struct snd_ac97 *ac97);
	void (*init) (struct snd_ac97 *ac97);
};

struct snd_ac97_bus {
	/* -- lowlevel (hardware) driver specific -- */
	struct snd_ac97_bus_ops *ops;
	void *private_data;
	void (*private_free) (struct snd_ac97_bus *bus);
	/* --- */
	struct snd_card *card;
	unsigned short num;	/* bus number */
	unsigned short no_vra: 1, /* bridge doesn't support VRA */
		       dra: 1,	/* bridge supports double rate */
		       isdin: 1;/* independent SDIN */
	unsigned int clock;	/* AC'97 base clock (usually 48000Hz) */
	spinlock_t bus_lock;	/* used mainly for slot allocation */
	unsigned short used_slots[2][4]; /* actually used PCM slots */
	unsigned short pcms_count; /* count of PCMs */
	struct ac97_pcm *pcms;
	struct snd_ac97 *codec[4];
	struct snd_info_entry *proc;
};

/* static resolution table */
struct snd_ac97_res_table {
	unsigned short reg;	/* register */
	unsigned short bits;	/* resolution bitmask */
};

struct snd_ac97_template {
	void *private_data;
	void (*private_free) (struct snd_ac97 *ac97);
	struct pci_dev *pci;	/* assigned PCI device - used for quirks */
	unsigned short num;	/* number of codec: 0 = primary, 1 = secondary */
	unsigned short addr;	/* physical address of codec [0-3] */
	unsigned int scaps;	/* driver capabilities */
	const struct snd_ac97_res_table *res_table;	/* static resolution */
};

struct snd_ac97 {
	/* -- lowlevel (hardware) driver specific -- */
	const struct snd_ac97_build_ops *build_ops;
	void *private_data;
	void (*private_free) (struct snd_ac97 *ac97);
	/* --- */
	struct snd_ac97_bus *bus;
	struct pci_dev *pci;	/* assigned PCI device - used for quirks */
	struct snd_info_entry *proc;
	struct snd_info_entry *proc_regs;
	unsigned short subsystem_vendor;
	unsigned short subsystem_device;
	struct mutex reg_mutex;
	struct mutex page_mutex;	/* mutex for AD18xx multi-codecs and paging (2.3) */
	unsigned short num;	/* number of codec: 0 = primary, 1 = secondary */
	unsigned short addr;	/* physical address of codec [0-3] */
	unsigned int id;	/* identification of codec */
	unsigned short caps;	/* capabilities (register 0) */
	unsigned short ext_id;	/* extended feature identification (register 28) */
	unsigned short ext_mid;	/* extended modem ID (register 3C) */
	const struct snd_ac97_res_table *res_table;	/* static resolution */
	unsigned int scaps;	/* driver capabilities */
	unsigned int flags;	/* specific code */
	unsigned int rates[6];	/* see AC97_RATES_* defines */
	unsigned int spdif_status;
	unsigned short regs[0x80]; /* register cache */
	DECLARE_BITMAP(reg_accessed, 0x80); /* bit flags */
	union {			/* vendor specific code */
		struct {
			unsigned short unchained[3];	// 0 = C34, 1 = C79, 2 = C69
			unsigned short chained[3];	// 0 = C34, 1 = C79, 2 = C69
			unsigned short id[3];		// codec IDs (lower 16-bit word)
			unsigned short pcmreg[3];	// PCM registers
			unsigned short codec_cfg[3];	// CODEC_CFG bits
			unsigned char swap_mic_linein;	// AD1986/AD1986A only
			unsigned char lo_as_master;	/* LO as master */
		} ad18xx;
		unsigned int dev_flags;		/* device specific */
	} spec;
	/* jack-sharing info */
	unsigned char indep_surround;
	unsigned char channel_mode;

#ifdef CONFIG_SND_AC97_POWER_SAVE
	unsigned int power_up;	/* power states */
	struct delayed_work power_work;
#endif
	struct device dev;
	struct snd_ac97_gpio_priv *gpio_priv;

	struct snd_pcm_chmap *chmaps[2]; /* channel-maps (optional) */
};

#define to_ac97_t(d) container_of(d, struct snd_ac97, dev)

/* conditions */
static inline int ac97_is_audio(struct snd_ac97 * ac97)
{
	return (ac97->scaps & AC97_SCAP_AUDIO);
}
static inline int ac97_is_modem(struct snd_ac97 * ac97)
{
	return (ac97->scaps & AC97_SCAP_MODEM);
}
static inline int ac97_is_rev22(struct snd_ac97 * ac97)
{
	return (ac97->ext_id & AC97_EI_REV_MASK) >= AC97_EI_REV_22;
}
static inline int ac97_can_amap(struct snd_ac97 * ac97)
{
	return (ac97->ext_id & AC97_EI_AMAP) != 0;
}
static inline int ac97_can_spdif(struct snd_ac97 * ac97)
{
	return (ac97->ext_id & AC97_EI_SPDIF) != 0;
}

/* functions */
/* create new AC97 bus */
int snd_ac97_bus(struct snd_card *card, int num, struct snd_ac97_bus_ops *ops,
		 void *private_data, struct snd_ac97_bus **rbus);
/* create mixer controls */
int snd_ac97_mixer(struct snd_ac97_bus *bus, struct snd_ac97_template *template,
		   struct snd_ac97 **rac97);
const char *snd_ac97_get_short_name(struct snd_ac97 *ac97);

void snd_ac97_write(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
unsigned short snd_ac97_read(struct snd_ac97 *ac97, unsigned short reg);
void snd_ac97_write_cache(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
int snd_ac97_update(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
int snd_ac97_update_bits(struct snd_ac97 *ac97, unsigned short reg, unsigned short mask, unsigned short value);
#ifdef CONFIG_SND_AC97_POWER_SAVE
int snd_ac97_update_power(struct snd_ac97 *ac97, int reg, int powerup);
#else
static inline int snd_ac97_update_power(struct snd_ac97 *ac97, int reg,
					int powerup)
{
	return 0;
}
#endif
#ifdef CONFIG_PM
void snd_ac97_suspend(struct snd_ac97 *ac97);
void snd_ac97_resume(struct snd_ac97 *ac97);
#endif
int snd_ac97_reset(struct snd_ac97 *ac97, bool try_warm, unsigned int id,
	unsigned int id_mask);

/* quirk types */
enum {
	AC97_TUNE_DEFAULT = -1,	/* use default from quirk list (not valid in list) */
	AC97_TUNE_NONE = 0,	/* nothing extra to do */
	AC97_TUNE_HP_ONLY,	/* headphone (true line-out) control as master only */
	AC97_TUNE_SWAP_HP,	/* swap headphone and master controls */
	AC97_TUNE_SWAP_SURROUND, /* swap master and surround controls */
	AC97_TUNE_AD_SHARING,	/* for AD1985, turn on OMS bit and use headphone */
	AC97_TUNE_ALC_JACK,	/* for Realtek, enable JACK detection */
	AC97_TUNE_INV_EAPD,	/* inverted EAPD implementation */
	AC97_TUNE_MUTE_LED,	/* EAPD bit works as mute LED */
	AC97_TUNE_HP_MUTE_LED,  /* EAPD bit works as mute LED, use headphone control as master */
};

struct ac97_quirk {
	unsigned short subvendor; /* PCI subsystem vendor id */
	unsigned short subdevice; /* PCI subsystem device id */
	unsigned short mask;	/* device id bit mask, 0 = accept all */
	unsigned int codec_id;	/* codec id (if any), 0 = accept all */
	const char *name;	/* name shown as info */
	int type;		/* quirk type above */
};

int snd_ac97_tune_hardware(struct snd_ac97 *ac97,
			   const struct ac97_quirk *quirk,
			   const char *override);
int snd_ac97_set_rate(struct snd_ac97 *ac97, int reg, unsigned int rate);

/*
 * PCM allocation
 */

enum ac97_pcm_cfg {
	AC97_PCM_CFG_FRONT = 2,
	AC97_PCM_CFG_REAR = 10,		/* alias surround */
	AC97_PCM_CFG_LFE = 11,		/* center + lfe */
	AC97_PCM_CFG_40 = 4,		/* front + rear */
	AC97_PCM_CFG_51 = 6,		/* front + rear + center/lfe */
	AC97_PCM_CFG_SPDIF = 20
};

struct ac97_pcm {
	struct snd_ac97_bus *bus;
	unsigned int stream: 1,	   	   /* stream type: 1 = capture */
		     exclusive: 1,	   /* exclusive mode, don't override with other pcms */
		     copy_flag: 1,	   /* lowlevel driver must fill all entries */
		     spdif: 1;		   /* spdif pcm */
	unsigned short aslots;		   /* active slots */
	unsigned short cur_dbl;		   /* current double-rate state */
	unsigned int rates;		   /* available rates */
	struct {
		unsigned short slots;	   /* driver input: requested AC97 slot numbers */
		unsigned short rslots[4];  /* allocated slots per codecs */
		unsigned char rate_table[4];
		struct snd_ac97 *codec[4];	   /* allocated codecs */
	} r[2];				   /* 0 = standard rates, 1 = double rates */
	unsigned long private_value;	   /* used by the hardware driver */
};

int snd_ac97_pcm_assign(struct snd_ac97_bus *ac97,
			unsigned short pcms_count,
			const struct ac97_pcm *pcms);
int snd_ac97_pcm_open(struct ac97_pcm *pcm, unsigned int rate,
		      enum ac97_pcm_cfg cfg, unsigned short slots);
int snd_ac97_pcm_close(struct ac97_pcm *pcm);
int snd_ac97_pcm_double_rate_rules(struct snd_pcm_runtime *runtime);

/* ad hoc AC97 device driver access */
extern struct bus_type ac97_bus_type;

/* AC97 platform_data adding function */
static inline void snd_ac97_dev_add_pdata(struct snd_ac97 *ac97, void *data)
{
	ac97->dev.platform_data = data;
}

#endif /* __SOUND_AC97_CODEC_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef __SOUND_AC97_CODEC_H
	2	#define __SOUND_AC97_CODEC_H
	3
	4	/*
c1017a4c	5	* Copyright (c) by Jaroslav Kysela <perex@perex.cz>
1da177e4 LT	6	* Universal interface for Audio Codec '97
	7	*
	8	* For more details look to AC '97 component specification revision 2.1
	9	* by Intel Corporation (http://developer.intel.com).
	10	*
	11	*
	12	* This program is free software; you can redistribute it and/or modify
	13	* it under the terms of the GNU General Public License as published by
	14	* the Free Software Foundation; either version 2 of the License, or
	15	* (at your option) any later version.
	16	*
	17	* This program is distributed in the hope that it will be useful,
	18	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	* GNU General Public License for more details.
	21	*
	22	* You should have received a copy of the GNU General Public License
	23	* along with this program; if not, write to the Free Software
	24	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	25	*
	26	*/
	27
	28	#include <linux/bitops.h>
0ca06a00	29	#include <linux/device.h>
6dbe6628	30	#include <linux/workqueue.h>
8e4f7d9b	31	#include <sound/ac97/regs.h>
a1ce3928 DH	32	#include <sound/pcm.h>
	33	#include <sound/control.h>
	34	#include <sound/info.h>
1da177e4	35
4ac0478f MV	36	/* maximum number of devices on the AC97 bus */
	37	#define AC97_BUS_MAX_DEVICES 4
	38
1da177e4 LT	39	/* specific - SigmaTel */
	40	#define AC97_SIGMATEL_OUTSEL 0x64 /* Output Select, STAC9758 */
	41	#define AC97_SIGMATEL_INSEL 0x66 /* Input Select, STAC9758 */
	42	#define AC97_SIGMATEL_IOMISC 0x68 /* STAC9758 */
	43	#define AC97_SIGMATEL_ANALOG 0x6c /* Analog Special */
	44	#define AC97_SIGMATEL_DAC2INVERT 0x6e
	45	#define AC97_SIGMATEL_BIAS1 0x70
	46	#define AC97_SIGMATEL_BIAS2 0x72
	47	#define AC97_SIGMATEL_VARIOUS 0x72 /* STAC9758 */
	48	#define AC97_SIGMATEL_MULTICHN 0x74 /* Multi-Channel programming */
	49	#define AC97_SIGMATEL_CIC1 0x76
	50	#define AC97_SIGMATEL_CIC2 0x78
	51
	52	/* specific - Analog Devices */
	53	#define AC97_AD_TEST 0x5a /* test register */
02856b56	54	#define AC97_AD_TEST2 0x5c /* undocumented test register 2 */
0bed7b29	55	#define AC97_AD_HPFD_SHIFT 12 /* High Pass Filter Disable */
1da177e4 LT	56	#define AC97_AD_CODEC_CFG 0x70 /* codec configuration */
	57	#define AC97_AD_JACK_SPDIF 0x72 /* Jack Sense & S/PDIF */
	58	#define AC97_AD_SERIAL_CFG 0x74 /* Serial Configuration */
	59	#define AC97_AD_MISC 0x76 /* Misc Control Bits */
0bed7b29	60	#define AC97_AD_VREFD_SHIFT 2 /* V_REFOUT Disable (AD1888) */
1da177e4 LT	61
	62	/* specific - Cirrus Logic */
	63	#define AC97_CSR_ACMODE 0x5e /* AC Mode Register */
	64	#define AC97_CSR_MISC_CRYSTAL 0x60 /* Misc Crystal Control */
	65	#define AC97_CSR_SPDIF 0x68 /* S/PDIF Register */
	66	#define AC97_CSR_SERIAL 0x6a /* Serial Port Control */
	67	#define AC97_CSR_SPECF_ADDR 0x6c /* Special Feature Address */
	68	#define AC97_CSR_SPECF_DATA 0x6e /* Special Feature Data */
	69	#define AC97_CSR_BDI_STATUS 0x7a /* BDI Status */
	70
	71	/* specific - Conexant */
	72	#define AC97_CXR_AUDIO_MISC 0x5c
	73	#define AC97_CXR_SPDIFEN (1<<3)
	74	#define AC97_CXR_COPYRGT (1<<2)
	75	#define AC97_CXR_SPDIF_MASK (3<<0)
	76	#define AC97_CXR_SPDIF_PCM 0x0
	77	#define AC97_CXR_SPDIF_AC3 0x2
	78
	79	/* specific - ALC */
	80	#define AC97_ALC650_SPDIF_INPUT_STATUS1 0x60
	81	/* S/PDIF input status 1 bit defines */
	82	#define AC97_ALC650_PRO 0x0001 /* Professional status */
	83	#define AC97_ALC650_NAUDIO 0x0002 /* Non audio stream */
	84	#define AC97_ALC650_COPY 0x0004 /* Copyright status */
	85	#define AC97_ALC650_PRE 0x0038 /* Preemphasis status */
	86	#define AC97_ALC650_PRE_SHIFT 3
	87	#define AC97_ALC650_MODE 0x00C0 /* Preemphasis status */
	88	#define AC97_ALC650_MODE_SHIFT 6
	89	#define AC97_ALC650_CC_MASK 0x7f00 /* Category Code mask */
	90	#define AC97_ALC650_CC_SHIFT 8
	91	#define AC97_ALC650_L 0x8000 /* Generation Level status */
	92
	93	#define AC97_ALC650_SPDIF_INPUT_STATUS2 0x62
	94	/* S/PDIF input status 2 bit defines */
	95	#define AC97_ALC650_SOUCE_MASK 0x000f /* Source number */
	96	#define AC97_ALC650_CHANNEL_MASK 0x00f0 /* Channel number */
	97	#define AC97_ALC650_CHANNEL_SHIFT 4
	98	#define AC97_ALC650_SPSR_MASK 0x0f00 /* S/PDIF Sample Rate bits */
	99	#define AC97_ALC650_SPSR_SHIFT 8
	100	#define AC97_ALC650_SPSR_44K 0x0000 /* Use 44.1kHz Sample rate */
	101	#define AC97_ALC650_SPSR_48K 0x0200 /* Use 48kHz Sample rate */
	102	#define AC97_ALC650_SPSR_32K 0x0300 /* Use 32kHz Sample rate */
	103	#define AC97_ALC650_CLOCK_ACCURACY 0x3000 /* Clock accuracy */
	104	#define AC97_ALC650_CLOCK_SHIFT 12
	105	#define AC97_ALC650_CLOCK_LOCK 0x4000 /* Clock locked status */
	106	#define AC97_ALC650_V 0x8000 /* Validity status */
	107
	108	#define AC97_ALC650_SURR_DAC_VOL 0x64
	109	#define AC97_ALC650_LFE_DAC_VOL 0x66
	110	#define AC97_ALC650_UNKNOWN1 0x68
	111	#define AC97_ALC650_MULTICH 0x6a
	112	#define AC97_ALC650_UNKNOWN2 0x6c
	113	#define AC97_ALC650_REVISION 0x6e
	114	#define AC97_ALC650_UNKNOWN3 0x70
	115	#define AC97_ALC650_UNKNOWN4 0x72
	116	#define AC97_ALC650_MISC 0x74
	117	#define AC97_ALC650_GPIO_SETUP 0x76
	118	#define AC97_ALC650_GPIO_STATUS 0x78
	119	#define AC97_ALC650_CLOCK 0x7a
	120
13043984 KM	121	/* specific - Yamaha YMF7x3 */
	122	#define AC97_YMF7X3_DIT_CTRL 0x66 /* DIT Control (YMF743) / 2 (YMF753) */
	123	#define AC97_YMF7X3_3D_MODE_SEL 0x68 /* 3D Mode Select */
1da177e4 LT	124
	125	/* specific - C-Media */
	126	#define AC97_CM9738_VENDOR_CTRL 0x5a
	127	#define AC97_CM9739_MULTI_CHAN 0x64
	128	#define AC97_CM9739_SPDIF_IN_STATUS 0x68 /* 32bit */
	129	#define AC97_CM9739_SPDIF_CTRL 0x6c
	130
	131	/* specific - wolfson */
	132	#define AC97_WM97XX_FMIXER_VOL 0x72
	133	#define AC97_WM9704_RMIXER_VOL 0x74
	134	#define AC97_WM9704_TEST 0x5a
	135	#define AC97_WM9704_RPCM_VOL 0x70
	136	#define AC97_WM9711_OUT3VOL 0x16
	137
	138
	139	/* ac97->scaps */
	140	#define AC97_SCAP_AUDIO (1<<0) /* audio codec 97 */
	141	#define AC97_SCAP_MODEM (1<<1) /* modem codec 97 */
	142	#define AC97_SCAP_SURROUND_DAC (1<<2) /* surround L&R DACs are present */
	143	#define AC97_SCAP_CENTER_LFE_DAC (1<<3) /* center and LFE DACs are present */
	144	#define AC97_SCAP_SKIP_AUDIO (1<<4) /* skip audio part of codec */
	145	#define AC97_SCAP_SKIP_MODEM (1<<5) /* skip modem part of codec */
	146	#define AC97_SCAP_INDEP_SDIN (1<<6) /* independent SDIN */
	147	#define AC97_SCAP_INV_EAPD (1<<7) /* inverted EAPD */
	148	#define AC97_SCAP_DETECT_BY_VENDOR (1<<8) /* use vendor registers for read tests */
	149	#define AC97_SCAP_NO_SPDIF (1<<9) /* don't build SPDIF controls */
6dbe6628	150	#define AC97_SCAP_EAPD_LED (1<<10) /* EAPD as mute LED */
25985edc	151	#define AC97_SCAP_POWER_SAVE (1<<11) /* capable for aggressive power-saving */
1da177e4 LT	152
	153	/* ac97->flags */
	154	#define AC97_HAS_PC_BEEP (1<<0) /* force PC Speaker usage */
	155	#define AC97_AD_MULTI (1<<1) /* Analog Devices - multi codecs */
	156	#define AC97_CS_SPDIF (1<<2) /* Cirrus Logic uses funky SPDIF */
	157	#define AC97_CX_SPDIF (1<<3) /* Conexant's spdif interface */
	158	#define AC97_STEREO_MUTES (1<<4) /* has stereo mute bits */
	159	#define AC97_DOUBLE_RATE (1<<5) /* supports double rate playback */
	160	#define AC97_HAS_NO_MASTER_VOL (1<<6) /* no Master volume */
	161	#define AC97_HAS_NO_PCM_VOL (1<<7) /* no PCM volume */
	162	#define AC97_DEFAULT_POWER_OFF (1<<8) /* no RESET write */
	163	#define AC97_MODEM_PATCH (1<<9) /* modem patch */
	164	#define AC97_HAS_NO_REC_GAIN (1<<10) /* no Record gain */
	165	#define AC97_HAS_NO_PHONE (1<<11) /* no PHONE volume */
	166	#define AC97_HAS_NO_PC_BEEP (1<<12) /* no PC Beep volume */
	167	#define AC97_HAS_NO_VIDEO (1<<13) /* no Video volume */
	168	#define AC97_HAS_NO_CD (1<<14) /* no CD volume */
3998b70f LG	169	#define AC97_HAS_NO_MIC (1<<15) /* no MIC volume */
	170	#define AC97_HAS_NO_TONE (1<<16) /* no Tone volume */
	171	#define AC97_HAS_NO_STD_PCM (1<<17) /* no standard AC97 PCM volume and mute */
1459c784	172	#define AC97_HAS_NO_AUX (1<<18) /* no standard AC97 AUX volume and mute */
4235a317	173	#define AC97_HAS_8CH (1<<19) /* supports 8-channel output */
1da177e4 LT	174
	175	/* rates indexes */
	176	#define AC97_RATES_FRONT_DAC 0
	177	#define AC97_RATES_SURR_DAC 1
	178	#define AC97_RATES_LFE_DAC 2
	179	#define AC97_RATES_ADC 3
	180	#define AC97_RATES_MIC_ADC 4
	181	#define AC97_RATES_SPDIF 5
	182
9bf5c3d1	183	#define AC97_NUM_GPIOS 16
1da177e4 LT	184	/*
	185	*
	186	*/
	187
ee42381e	188	struct snd_ac97;
9bf5c3d1	189	struct snd_ac97_gpio_priv;
833a493b	190	struct snd_pcm_chmap;
1da177e4	191
1da177e4	192	struct snd_ac97_build_ops {
ee42381e TI	193	int (build_3d) (struct snd_ac97 ac97);
	194	int (build_specific) (struct snd_ac97 ac97);
	195	int (build_spdif) (struct snd_ac97 ac97);
	196	int (build_post_spdif) (struct snd_ac97 ac97);
1da177e4	197	#ifdef CONFIG_PM
ee42381e TI	198	void (suspend) (struct snd_ac97 ac97);
ee42381e TI	199	void (resume) (struct snd_ac97 ac97);
1da177e4	200	#endif
ee42381e	201	void (update_jacks) (struct snd_ac97 ac97); /* for jack-sharing */
1da177e4 LT	202	};
1da177e4 LT	203
ee42381e TI	204	struct snd_ac97_bus_ops {
ee42381e TI	205	void (reset) (struct snd_ac97 ac97);
808db4a4	206	void (warm_reset)(struct snd_ac97 ac97);
ee42381e TI	207	void (write) (struct snd_ac97 ac97, unsigned short reg, unsigned short val);
	208	unsigned short (read) (struct snd_ac97 ac97, unsigned short reg);
	209	void (wait) (struct snd_ac97 ac97);
	210	void (init) (struct snd_ac97 ac97);
1da177e4 LT	211	};
1da177e4 LT	212
ee42381e	213	struct snd_ac97_bus {
1da177e4	214	/* -- lowlevel (hardware) driver specific -- */
ee42381e	215	struct snd_ac97_bus_ops *ops;
1da177e4	216	void *private_data;
ee42381e	217	void (private_free) (struct snd_ac97_bus bus);
1da177e4	218	/* --- */
ee42381e	219	struct snd_card *card;
1da177e4 LT	220	unsigned short num; /* bus number */
	221	unsigned short no_vra: 1, /* bridge doesn't support VRA */
	222	dra: 1, /* bridge supports double rate */
	223	isdin: 1;/* independent SDIN */
	224	unsigned int clock; /* AC'97 base clock (usually 48000Hz) */
	225	spinlock_t bus_lock; /* used mainly for slot allocation */
	226	unsigned short used_slots[2][4]; /* actually used PCM slots */
	227	unsigned short pcms_count; /* count of PCMs */
	228	struct ac97_pcm *pcms;
ee42381e TI	229	struct snd_ac97 *codec[4];
ee42381e TI	230	struct snd_info_entry *proc;
1da177e4 LT	231	};
1da177e4 LT	232
7c5706bb TI	233	/* static resolution table */
	234	struct snd_ac97_res_table {
	235	unsigned short reg; /* register */
	236	unsigned short bits; /* resolution bitmask */
	237	};
	238
ee42381e	239	struct snd_ac97_template {
1da177e4	240	void *private_data;
ee42381e	241	void (private_free) (struct snd_ac97 ac97);
1da177e4 LT	242	struct pci_dev pci; / assigned PCI device - used for quirks */
	243	unsigned short num; /* number of codec: 0 = primary, 1 = secondary */
	244	unsigned short addr; /* physical address of codec [0-3] */
	245	unsigned int scaps; /* driver capabilities */
7c5706bb	246	const struct snd_ac97_res_table res_table; / static resolution */
50dabc2d TI	247	};
50dabc2d TI	248
ee42381e	249	struct snd_ac97 {
1da177e4	250	/* -- lowlevel (hardware) driver specific -- */
3e8b3b90	251	const struct snd_ac97_build_ops *build_ops;
1da177e4	252	void *private_data;
ee42381e	253	void (private_free) (struct snd_ac97 ac97);
1da177e4	254	/* --- */
ee42381e	255	struct snd_ac97_bus *bus;
1da177e4	256	struct pci_dev pci; / assigned PCI device - used for quirks */
ee42381e TI	257	struct snd_info_entry *proc;
ee42381e TI	258	struct snd_info_entry *proc_regs;
1da177e4 LT	259	unsigned short subsystem_vendor;
1da177e4 LT	260	unsigned short subsystem_device;
62932df8 IM	261	struct mutex reg_mutex;
62932df8 IM	262	struct mutex page_mutex; /* mutex for AD18xx multi-codecs and paging (2.3) */
1da177e4 LT	263	unsigned short num; /* number of codec: 0 = primary, 1 = secondary */
	264	unsigned short addr; /* physical address of codec [0-3] */
	265	unsigned int id; /* identification of codec */
	266	unsigned short caps; /* capabilities (register 0) */
	267	unsigned short ext_id; /* extended feature identification (register 28) */
	268	unsigned short ext_mid; /* extended modem ID (register 3C) */
50dabc2d	269	const struct snd_ac97_res_table res_table; / static resolution */
1da177e4 LT	270	unsigned int scaps; /* driver capabilities */
	271	unsigned int flags; /* specific code */
	272	unsigned int rates[6]; /* see AC97_RATES_* defines */
	273	unsigned int spdif_status;
	274	unsigned short regs[0x80]; /* register cache */
1da177e4 LT	275	DECLARE_BITMAP(reg_accessed, 0x80); /* bit flags */
	276	union { /* vendor specific code */
	277	struct {
	278	unsigned short unchained[3]; // 0 = C34, 1 = C79, 2 = C69
	279	unsigned short chained[3]; // 0 = C34, 1 = C79, 2 = C69
	280	unsigned short id[3]; // codec IDs (lower 16-bit word)
	281	unsigned short pcmreg[3]; // PCM registers
	282	unsigned short codec_cfg[3]; // CODEC_CFG bits
67e9f4b6	283	unsigned char swap_mic_linein; // AD1986/AD1986A only
e48d6d97	284	unsigned char lo_as_master; /* LO as master */
1da177e4 LT	285	} ad18xx;
	286	unsigned int dev_flags; /* device specific */
	287	} spec;
eb8caf30 TI	288	/* jack-sharing info */
	289	unsigned char indep_surround;
	290	unsigned char channel_mode;
6dbe6628 TI	291
	292	#ifdef CONFIG_SND_AC97_POWER_SAVE
	293	unsigned int power_up; /* power states */
c4028958	294	struct delayed_work power_work;
6dbe6628	295	#endif
0ca06a00	296	struct device dev;
9bf5c3d1	297	struct snd_ac97_gpio_priv *gpio_priv;
833a493b TI	298
833a493b TI	299	struct snd_pcm_chmap chmaps[2]; / channel-maps (optional) */
1da177e4 LT	300	};
1da177e4 LT	301
ee42381e	302	#define to_ac97_t(d) container_of(d, struct snd_ac97, dev)
72e75de2	303
1da177e4	304	/* conditions */
ee42381e	305	static inline int ac97_is_audio(struct snd_ac97 * ac97)
1da177e4 LT	306	{
	307	return (ac97->scaps & AC97_SCAP_AUDIO);
	308	}
ee42381e	309	static inline int ac97_is_modem(struct snd_ac97 * ac97)
1da177e4 LT	310	{
	311	return (ac97->scaps & AC97_SCAP_MODEM);
	312	}
ee42381e	313	static inline int ac97_is_rev22(struct snd_ac97 * ac97)
1da177e4 LT	314	{
	315	return (ac97->ext_id & AC97_EI_REV_MASK) >= AC97_EI_REV_22;
	316	}
ee42381e	317	static inline int ac97_can_amap(struct snd_ac97 * ac97)
1da177e4 LT	318	{
	319	return (ac97->ext_id & AC97_EI_AMAP) != 0;
	320	}
ee42381e	321	static inline int ac97_can_spdif(struct snd_ac97 * ac97)
1da177e4 LT	322	{
	323	return (ac97->ext_id & AC97_EI_SPDIF) != 0;
	324	}
	325
	326	/* functions */
ee42381e TI	327	/* create new AC97 bus */
	328	int snd_ac97_bus(struct snd_card card, int num, struct snd_ac97_bus_ops ops,
	329	void private_data, struct snd_ac97_bus *rbus);
	330	/* create mixer controls */
	331	int snd_ac97_mixer(struct snd_ac97_bus bus, struct snd_ac97_template template,
	332	struct snd_ac97 **rac97);
	333	const char snd_ac97_get_short_name(struct snd_ac97 ac97);
	334
	335	void snd_ac97_write(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
	336	unsigned short snd_ac97_read(struct snd_ac97 *ac97, unsigned short reg);
	337	void snd_ac97_write_cache(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
	338	int snd_ac97_update(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
	339	int snd_ac97_update_bits(struct snd_ac97 *ac97, unsigned short reg, unsigned short mask, unsigned short value);
6dbe6628 TI	340	#ifdef CONFIG_SND_AC97_POWER_SAVE
	341	int snd_ac97_update_power(struct snd_ac97 *ac97, int reg, int powerup);
	342	#else
	343	static inline int snd_ac97_update_power(struct snd_ac97 *ac97, int reg,
	344	int powerup)
	345	{
	346	return 0;
	347	}
	348	#endif
1da177e4	349	#ifdef CONFIG_PM
ee42381e TI	350	void snd_ac97_suspend(struct snd_ac97 *ac97);
ee42381e TI	351	void snd_ac97_resume(struct snd_ac97 *ac97);
1da177e4	352	#endif
5f1d980e LPC	353	int snd_ac97_reset(struct snd_ac97 *ac97, bool try_warm, unsigned int id,
5f1d980e LPC	354	unsigned int id_mask);
1da177e4 LT	355
	356	/* quirk types */
	357	enum {
	358	AC97_TUNE_DEFAULT = -1, /* use default from quirk list (not valid in list) */
	359	AC97_TUNE_NONE = 0, /* nothing extra to do */
	360	AC97_TUNE_HP_ONLY, /* headphone (true line-out) control as master only */
	361	AC97_TUNE_SWAP_HP, /* swap headphone and master controls */
	362	AC97_TUNE_SWAP_SURROUND, /* swap master and surround controls */
	363	AC97_TUNE_AD_SHARING, /* for AD1985, turn on OMS bit and use headphone */
	364	AC97_TUNE_ALC_JACK, /* for Realtek, enable JACK detection */
	365	AC97_TUNE_INV_EAPD, /* inverted EAPD implementation */
	366	AC97_TUNE_MUTE_LED, /* EAPD bit works as mute LED */
a0faefed	367	AC97_TUNE_HP_MUTE_LED, /* EAPD bit works as mute LED, use headphone control as master */
1da177e4 LT	368	};
	369
	370	struct ac97_quirk {
69ad07cf	371	unsigned short subvendor; /* PCI subsystem vendor id */
83cf0a9b	372	unsigned short subdevice; /* PCI subsystem device id */
1da177e4 LT	373	unsigned short mask; /* device id bit mask, 0 = accept all */
	374	unsigned int codec_id; /* codec id (if any), 0 = accept all */
	375	const char name; / name shown as info */
	376	int type; /* quirk type above */
	377	};
	378
eab0fbfa JP	379	int snd_ac97_tune_hardware(struct snd_ac97 *ac97,
	380	const struct ac97_quirk *quirk,
	381	const char *override);
ee42381e	382	int snd_ac97_set_rate(struct snd_ac97 *ac97, int reg, unsigned int rate);
1da177e4	383
b9b4bdd9 TI	384	/*
	385	* PCM allocation
	386	*/
	387
	388	enum ac97_pcm_cfg {
	389	AC97_PCM_CFG_FRONT = 2,
	390	AC97_PCM_CFG_REAR = 10, /* alias surround */
	391	AC97_PCM_CFG_LFE = 11, /* center + lfe */
	392	AC97_PCM_CFG_40 = 4, /* front + rear */
	393	AC97_PCM_CFG_51 = 6, /* front + rear + center/lfe */
	394	AC97_PCM_CFG_SPDIF = 20
	395	};
	396
	397	struct ac97_pcm {
ee42381e	398	struct snd_ac97_bus *bus;
b9b4bdd9 TI	399	unsigned int stream: 1, /* stream type: 1 = capture */
	400	exclusive: 1, /* exclusive mode, don't override with other pcms */
	401	copy_flag: 1, /* lowlevel driver must fill all entries */
	402	spdif: 1; /* spdif pcm */
	403	unsigned short aslots; /* active slots */
6dbe6628	404	unsigned short cur_dbl; /* current double-rate state */
b9b4bdd9 TI	405	unsigned int rates; /* available rates */
	406	struct {
	407	unsigned short slots; /* driver input: requested AC97 slot numbers */
	408	unsigned short rslots[4]; /* allocated slots per codecs */
	409	unsigned char rate_table[4];
ee42381e	410	struct snd_ac97 codec[4]; / allocated codecs */
b9b4bdd9 TI	411	} r[2]; /* 0 = standard rates, 1 = double rates */
	412	unsigned long private_value; /* used by the hardware driver */
	413	};
	414
ee42381e	415	int snd_ac97_pcm_assign(struct snd_ac97_bus *ac97,
1da177e4 LT	416	unsigned short pcms_count,
	417	const struct ac97_pcm *pcms);
	418	int snd_ac97_pcm_open(struct ac97_pcm *pcm, unsigned int rate,
	419	enum ac97_pcm_cfg cfg, unsigned short slots);
	420	int snd_ac97_pcm_close(struct ac97_pcm *pcm);
ee42381e	421	int snd_ac97_pcm_double_rate_rules(struct snd_pcm_runtime *runtime);
1da177e4	422
0ca06a00 LG	423	/* ad hoc AC97 device driver access */
	424	extern struct bus_type ac97_bus_type;
	425
474828a4 MV	426	/* AC97 platform_data adding function */
	427	static inline void snd_ac97_dev_add_pdata(struct snd_ac97 ac97, void data)
	428	{
	429	ac97->dev.platform_data = data;
	430	}
	431
1da177e4	432	#endif /* __SOUND_AC97_CODEC_H */