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

#ifndef __SOUND_CS4231_H
#define __SOUND_CS4231_H

/*
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
 *  Definitions for CS4231 & InterWave chips & compatible chips
 *
 *
 *   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 "control.h"
#include "pcm.h"
#include "timer.h"

#include "cs4231-regs.h"

/* defines for codec.mode */

#define CS4231_MODE_NONE	0x0000
#define CS4231_MODE_PLAY	0x0001
#define CS4231_MODE_RECORD	0x0002
#define CS4231_MODE_TIMER	0x0004
#define CS4231_MODE_OPEN	(CS4231_MODE_PLAY|CS4231_MODE_RECORD|CS4231_MODE_TIMER)

/* defines for codec.hardware */

#define CS4231_HW_DETECT        0x0000	/* let CS4231 driver detect chip */
#define CS4231_HW_DETECT3	0x0001	/* allow mode 3 */
#define CS4231_HW_TYPE_MASK	0xff00	/* type mask */
#define CS4231_HW_CS4231_MASK   0x0100	/* CS4231 serie */
#define CS4231_HW_CS4231        0x0100	/* CS4231 chip */
#define CS4231_HW_CS4231A       0x0101	/* CS4231A chip */
#define CS4231_HW_AD1845	0x0102	/* AD1845 chip */
#define CS4231_HW_CS4232_MASK   0x0200	/* CS4232 serie (has control ports) */
#define CS4231_HW_CS4232        0x0200	/* CS4232 */
#define CS4231_HW_CS4232A       0x0201	/* CS4232A */
#define CS4231_HW_CS4236	0x0202	/* CS4236 */
#define CS4231_HW_CS4236B_MASK	0x0400	/* CS4236B serie (has extended control regs) */
#define CS4231_HW_CS4235	0x0400	/* CS4235 - Crystal Clear (tm) stereo enhancement */
#define CS4231_HW_CS4236B       0x0401	/* CS4236B */
#define CS4231_HW_CS4237B       0x0402	/* CS4237B - SRS 3D */
#define CS4231_HW_CS4238B	0x0403	/* CS4238B - QSOUND 3D */
#define CS4231_HW_CS4239	0x0404	/* CS4239 - Crystal Clear (tm) stereo enhancement */
/* compatible, but clones */
#define CS4231_HW_INTERWAVE     0x1000	/* InterWave chip */
#define CS4231_HW_OPL3SA2       0x1101	/* OPL3-SA2 chip, similar to cs4231 */

/* defines for codec.hwshare */
#define CS4231_HWSHARE_IRQ	(1<<0)
#define CS4231_HWSHARE_DMA1	(1<<1)
#define CS4231_HWSHARE_DMA2	(1<<2)

struct snd_cs4231 {
	unsigned long port;		/* base i/o port */
	struct resource *res_port;
	unsigned long cport;		/* control base i/o port (CS4236) */
	struct resource *res_cport;
	int irq;			/* IRQ line */
	int dma1;			/* playback DMA */
	int dma2;			/* record DMA */
	unsigned short version;		/* version of CODEC chip */
	unsigned short mode;		/* see to CS4231_MODE_XXXX */
	unsigned short hardware;	/* see to CS4231_HW_XXXX */
	unsigned short hwshare;		/* shared resources */
	unsigned short single_dma:1,	/* forced single DMA mode (GUS 16-bit daughter board) or dma1 == dma2 */
		       ebus_flag:1;	/* SPARC: EBUS present */

	struct snd_card *card;
	struct snd_pcm *pcm;
	struct snd_pcm_substream *playback_substream;
	struct snd_pcm_substream *capture_substream;
	struct snd_timer *timer;

	unsigned char image[32];	/* registers image */
	unsigned char eimage[32];	/* extended registers image */
	unsigned char cimage[16];	/* control registers image */
	int mce_bit;
	int calibrate_mute;
	int sw_3d_bit;
	unsigned int p_dma_size;
	unsigned int c_dma_size;

	spinlock_t reg_lock;
	struct mutex mce_mutex;
	struct mutex open_mutex;

	int (*rate_constraint) (struct snd_pcm_runtime *runtime);
	void (*set_playback_format) (struct snd_cs4231 *chip, struct snd_pcm_hw_params *hw_params, unsigned char pdfr);
	void (*set_capture_format) (struct snd_cs4231 *chip, struct snd_pcm_hw_params *hw_params, unsigned char cdfr);
	void (*trigger) (struct snd_cs4231 *chip, unsigned int what, int start);
#ifdef CONFIG_PM
	void (*suspend) (struct snd_cs4231 *chip);
	void (*resume) (struct snd_cs4231 *chip);
#endif
	void *dma_private_data;
	int (*claim_dma) (struct snd_cs4231 *chip, void *dma_private_data, int dma);
	int (*release_dma) (struct snd_cs4231 *chip, void *dma_private_data, int dma);
};

/* exported functions */

void snd_cs4231_out(struct snd_cs4231 *chip, unsigned char reg, unsigned char val);
unsigned char snd_cs4231_in(struct snd_cs4231 *chip, unsigned char reg);
void snd_cs4236_ext_out(struct snd_cs4231 *chip, unsigned char reg, unsigned char val);
unsigned char snd_cs4236_ext_in(struct snd_cs4231 *chip, unsigned char reg);
void snd_cs4231_mce_up(struct snd_cs4231 *chip);
void snd_cs4231_mce_down(struct snd_cs4231 *chip);

irqreturn_t snd_cs4231_interrupt(int irq, void *dev_id);

const char *snd_cs4231_chip_id(struct snd_cs4231 *chip);

int snd_cs4231_create(struct snd_card *card,
		      unsigned long port,
		      unsigned long cport,
		      int irq, int dma1, int dma2,
		      unsigned short hardware,
		      unsigned short hwshare,
		      struct snd_cs4231 ** rchip);
int snd_cs4231_pcm(struct snd_cs4231 * chip, int device, struct snd_pcm **rpcm);
int snd_cs4231_timer(struct snd_cs4231 * chip, int device, struct snd_timer **rtimer);
int snd_cs4231_mixer(struct snd_cs4231 * chip);

int snd_cs4236_create(struct snd_card *card,
		      unsigned long port,
		      unsigned long cport,
		      int irq, int dma1, int dma2,
		      unsigned short hardware,
		      unsigned short hwshare,
		      struct snd_cs4231 ** rchip);
int snd_cs4236_pcm(struct snd_cs4231 * chip, int device, struct snd_pcm **rpcm);
int snd_cs4236_mixer(struct snd_cs4231 * chip);

/*
 *  mixer library
 */

#define CS4231_SINGLE(xname, xindex, reg, shift, mask, invert) \
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
  .info = snd_cs4231_info_single, \
  .get = snd_cs4231_get_single, .put = snd_cs4231_put_single, \
  .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }

int snd_cs4231_info_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo);
int snd_cs4231_get_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
int snd_cs4231_put_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);

#define CS4231_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
  .info = snd_cs4231_info_double, \
  .get = snd_cs4231_get_double, .put = snd_cs4231_put_double, \
  .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }

int snd_cs4231_info_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo);
int snd_cs4231_get_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
int snd_cs4231_put_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);

#endif /* __SOUND_CS4231_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef __SOUND_CS4231_H
	2	#define __SOUND_CS4231_H
	3
	4	/*
c1017a4c	5	* Copyright (c) by Jaroslav Kysela <perex@perex.cz>
1da177e4 LT	6	* Definitions for CS4231 & InterWave chips & compatible chips
	7	*
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	22	*
	23	*/
	24
	25	#include "control.h"
	26	#include "pcm.h"
	27	#include "timer.h"
	28
f545714e	29	#include "cs4231-regs.h"
1da177e4 LT	30
	31	/* defines for codec.mode */
	32
	33	#define CS4231_MODE_NONE 0x0000
	34	#define CS4231_MODE_PLAY 0x0001
	35	#define CS4231_MODE_RECORD 0x0002
	36	#define CS4231_MODE_TIMER 0x0004
	37	#define CS4231_MODE_OPEN (CS4231_MODE_PLAY\|CS4231_MODE_RECORD\|CS4231_MODE_TIMER)
	38
	39	/* defines for codec.hardware */
	40
	41	#define CS4231_HW_DETECT 0x0000 /* let CS4231 driver detect chip */
	42	#define CS4231_HW_DETECT3 0x0001 /* allow mode 3 */
	43	#define CS4231_HW_TYPE_MASK 0xff00 /* type mask */
	44	#define CS4231_HW_CS4231_MASK 0x0100 /* CS4231 serie */
	45	#define CS4231_HW_CS4231 0x0100 /* CS4231 chip */
	46	#define CS4231_HW_CS4231A 0x0101 /* CS4231A chip */
	47	#define CS4231_HW_AD1845 0x0102 /* AD1845 chip */
	48	#define CS4231_HW_CS4232_MASK 0x0200 /* CS4232 serie (has control ports) */
	49	#define CS4231_HW_CS4232 0x0200 /* CS4232 */
	50	#define CS4231_HW_CS4232A 0x0201 /* CS4232A */
	51	#define CS4231_HW_CS4236 0x0202 /* CS4236 */
	52	#define CS4231_HW_CS4236B_MASK 0x0400 /* CS4236B serie (has extended control regs) */
	53	#define CS4231_HW_CS4235 0x0400 /* CS4235 - Crystal Clear (tm) stereo enhancement */
	54	#define CS4231_HW_CS4236B 0x0401 /* CS4236B */
	55	#define CS4231_HW_CS4237B 0x0402 /* CS4237B - SRS 3D */
	56	#define CS4231_HW_CS4238B 0x0403 /* CS4238B - QSOUND 3D */
	57	#define CS4231_HW_CS4239 0x0404 /* CS4239 - Crystal Clear (tm) stereo enhancement */
	58	/* compatible, but clones */
	59	#define CS4231_HW_INTERWAVE 0x1000 /* InterWave chip */
e2340465	60	#define CS4231_HW_OPL3SA2 0x1101 /* OPL3-SA2 chip, similar to cs4231 */
1da177e4 LT	61
	62	/* defines for codec.hwshare */
	63	#define CS4231_HWSHARE_IRQ (1<<0)
	64	#define CS4231_HWSHARE_DMA1 (1<<1)
	65	#define CS4231_HWSHARE_DMA2 (1<<2)
	66
ba2375a4	67	struct snd_cs4231 {
1da177e4	68	unsigned long port; /* base i/o port */
1da177e4 LT	69	struct resource *res_port;
	70	unsigned long cport; /* control base i/o port (CS4236) */
	71	struct resource *res_cport;
	72	int irq; /* IRQ line */
	73	int dma1; /* playback DMA */
	74	int dma2; /* record DMA */
1da177e4 LT	75	unsigned short version; /* version of CODEC chip */
	76	unsigned short mode; /* see to CS4231_MODE_XXXX */
	77	unsigned short hardware; /* see to CS4231_HW_XXXX */
	78	unsigned short hwshare; /* shared resources */
	79	unsigned short single_dma:1, /* forced single DMA mode (GUS 16-bit daughter board) or dma1 == dma2 */
	80	ebus_flag:1; /* SPARC: EBUS present */
	81
ba2375a4 TI	82	struct snd_card *card;
	83	struct snd_pcm *pcm;
	84	struct snd_pcm_substream *playback_substream;
	85	struct snd_pcm_substream *capture_substream;
	86	struct snd_timer *timer;
1da177e4 LT	87
	88	unsigned char image[32]; /* registers image */
	89	unsigned char eimage[32]; /* extended registers image */
	90	unsigned char cimage[16]; /* control registers image */
	91	int mce_bit;
	92	int calibrate_mute;
	93	int sw_3d_bit;
1da177e4 LT	94	unsigned int p_dma_size;
1da177e4 LT	95	unsigned int c_dma_size;
1da177e4 LT	96
1da177e4 LT	97	spinlock_t reg_lock;
8b7547f9 IM	98	struct mutex mce_mutex;
8b7547f9 IM	99	struct mutex open_mutex;
1da177e4	100
ba2375a4 TI	101	int (rate_constraint) (struct snd_pcm_runtime runtime);
	102	void (set_playback_format) (struct snd_cs4231 chip, struct snd_pcm_hw_params *hw_params, unsigned char pdfr);
	103	void (set_capture_format) (struct snd_cs4231 chip, struct snd_pcm_hw_params *hw_params, unsigned char cdfr);
	104	void (trigger) (struct snd_cs4231 chip, unsigned int what, int start);
1da177e4	105	#ifdef CONFIG_PM
ba2375a4 TI	106	void (suspend) (struct snd_cs4231 chip);
ba2375a4 TI	107	void (resume) (struct snd_cs4231 chip);
1da177e4 LT	108	#endif
1da177e4 LT	109	void *dma_private_data;
ba2375a4 TI	110	int (claim_dma) (struct snd_cs4231 chip, void *dma_private_data, int dma);
ba2375a4 TI	111	int (release_dma) (struct snd_cs4231 chip, void *dma_private_data, int dma);
1da177e4 LT	112	};
	113
	114	/* exported functions */
	115
ba2375a4 TI	116	void snd_cs4231_out(struct snd_cs4231 *chip, unsigned char reg, unsigned char val);
	117	unsigned char snd_cs4231_in(struct snd_cs4231 *chip, unsigned char reg);
	118	void snd_cs4236_ext_out(struct snd_cs4231 *chip, unsigned char reg, unsigned char val);
	119	unsigned char snd_cs4236_ext_in(struct snd_cs4231 *chip, unsigned char reg);
	120	void snd_cs4231_mce_up(struct snd_cs4231 *chip);
	121	void snd_cs4231_mce_down(struct snd_cs4231 *chip);
1da177e4	122
7d12e780	123	irqreturn_t snd_cs4231_interrupt(int irq, void *dev_id);
1da177e4	124
ba2375a4	125	const char snd_cs4231_chip_id(struct snd_cs4231 chip);
1da177e4	126
ba2375a4	127	int snd_cs4231_create(struct snd_card *card,
1da177e4 LT	128	unsigned long port,
	129	unsigned long cport,
	130	int irq, int dma1, int dma2,
	131	unsigned short hardware,
	132	unsigned short hwshare,
ba2375a4 TI	133	struct snd_cs4231 ** rchip);
	134	int snd_cs4231_pcm(struct snd_cs4231 * chip, int device, struct snd_pcm **rpcm);
	135	int snd_cs4231_timer(struct snd_cs4231 * chip, int device, struct snd_timer **rtimer);
	136	int snd_cs4231_mixer(struct snd_cs4231 * chip);
1da177e4	137
ba2375a4	138	int snd_cs4236_create(struct snd_card *card,
1da177e4 LT	139	unsigned long port,
	140	unsigned long cport,
	141	int irq, int dma1, int dma2,
	142	unsigned short hardware,
	143	unsigned short hwshare,
ba2375a4 TI	144	struct snd_cs4231 ** rchip);
	145	int snd_cs4236_pcm(struct snd_cs4231 * chip, int device, struct snd_pcm **rpcm);
	146	int snd_cs4236_mixer(struct snd_cs4231 * chip);
1da177e4 LT	147
	148	/*
	149	* mixer library
	150	*/
	151
	152	#define CS4231_SINGLE(xname, xindex, reg, shift, mask, invert) \
	153	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
	154	.info = snd_cs4231_info_single, \
	155	.get = snd_cs4231_get_single, .put = snd_cs4231_put_single, \
	156	.private_value = reg \| (shift << 8) \| (mask << 16) \| (invert << 24) }
	157
ba2375a4 TI	158	int snd_cs4231_info_single(struct snd_kcontrol kcontrol, struct snd_ctl_elem_info uinfo);
	159	int snd_cs4231_get_single(struct snd_kcontrol kcontrol, struct snd_ctl_elem_value ucontrol);
	160	int snd_cs4231_put_single(struct snd_kcontrol kcontrol, struct snd_ctl_elem_value ucontrol);
1da177e4 LT	161
	162	#define CS4231_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
	163	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
	164	.info = snd_cs4231_info_double, \
	165	.get = snd_cs4231_get_double, .put = snd_cs4231_put_double, \
	166	.private_value = left_reg \| (right_reg << 8) \| (shift_left << 16) \| (shift_right << 19) \| (mask << 24) \| (invert << 22) }
	167
ba2375a4 TI	168	int snd_cs4231_info_double(struct snd_kcontrol kcontrol, struct snd_ctl_elem_info uinfo);
	169	int snd_cs4231_get_double(struct snd_kcontrol kcontrol, struct snd_ctl_elem_value ucontrol);
	170	int snd_cs4231_put_double(struct snd_kcontrol kcontrol, struct snd_ctl_elem_value ucontrol);
1da177e4 LT	171
1da177e4 LT	172	#endif /* __SOUND_CS4231_H */