blob: f0785f9f4ae4939fc6289f53d1572e9f7802f4b1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __SOUND_CS4231_H
2#define __SOUND_CS4231_H
3
4/*
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02005 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * 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
Krzysztof Heltf5457142007-09-04 13:24:14 +020029#include "cs4231-regs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
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 */
Paul Vojtae2340462007-07-27 12:20:38 +020060#define CS4231_HW_OPL3SA2 0x1101 /* OPL3-SA2 chip, similar to cs4231 */
Krzysztof Heltabf1f5a2008-06-09 23:07:28 +020061#define CS4231_HW_OPTI93X 0x1102 /* Opti 930/931/933 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63/* defines for codec.hwshare */
64#define CS4231_HWSHARE_IRQ (1<<0)
65#define CS4231_HWSHARE_DMA1 (1<<1)
66#define CS4231_HWSHARE_DMA2 (1<<2)
67
Takashi Iwaiba2375a2005-11-17 14:30:42 +010068struct snd_cs4231 {
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 unsigned long port; /* base i/o port */
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 struct resource *res_port;
71 unsigned long cport; /* control base i/o port (CS4236) */
72 struct resource *res_cport;
73 int irq; /* IRQ line */
74 int dma1; /* playback DMA */
75 int dma2; /* record DMA */
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 unsigned short version; /* version of CODEC chip */
77 unsigned short mode; /* see to CS4231_MODE_XXXX */
78 unsigned short hardware; /* see to CS4231_HW_XXXX */
79 unsigned short hwshare; /* shared resources */
80 unsigned short single_dma:1, /* forced single DMA mode (GUS 16-bit daughter board) or dma1 == dma2 */
81 ebus_flag:1; /* SPARC: EBUS present */
82
Takashi Iwaiba2375a2005-11-17 14:30:42 +010083 struct snd_card *card;
84 struct snd_pcm *pcm;
85 struct snd_pcm_substream *playback_substream;
86 struct snd_pcm_substream *capture_substream;
87 struct snd_timer *timer;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
89 unsigned char image[32]; /* registers image */
90 unsigned char eimage[32]; /* extended registers image */
91 unsigned char cimage[16]; /* control registers image */
92 int mce_bit;
93 int calibrate_mute;
94 int sw_3d_bit;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 unsigned int p_dma_size;
96 unsigned int c_dma_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98 spinlock_t reg_lock;
Ingo Molnar8b7547f2006-01-16 16:33:08 +010099 struct mutex mce_mutex;
100 struct mutex open_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100102 int (*rate_constraint) (struct snd_pcm_runtime *runtime);
103 void (*set_playback_format) (struct snd_cs4231 *chip, struct snd_pcm_hw_params *hw_params, unsigned char pdfr);
104 void (*set_capture_format) (struct snd_cs4231 *chip, struct snd_pcm_hw_params *hw_params, unsigned char cdfr);
105 void (*trigger) (struct snd_cs4231 *chip, unsigned int what, int start);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106#ifdef CONFIG_PM
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100107 void (*suspend) (struct snd_cs4231 *chip);
108 void (*resume) (struct snd_cs4231 *chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109#endif
110 void *dma_private_data;
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100111 int (*claim_dma) (struct snd_cs4231 *chip, void *dma_private_data, int dma);
112 int (*release_dma) (struct snd_cs4231 *chip, void *dma_private_data, int dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113};
114
115/* exported functions */
116
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100117void snd_cs4231_out(struct snd_cs4231 *chip, unsigned char reg, unsigned char val);
118unsigned char snd_cs4231_in(struct snd_cs4231 *chip, unsigned char reg);
119void snd_cs4236_ext_out(struct snd_cs4231 *chip, unsigned char reg, unsigned char val);
120unsigned char snd_cs4236_ext_in(struct snd_cs4231 *chip, unsigned char reg);
121void snd_cs4231_mce_up(struct snd_cs4231 *chip);
122void snd_cs4231_mce_down(struct snd_cs4231 *chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Krzysztof Heltabf1f5a2008-06-09 23:07:28 +0200124void snd_cs4231_overrange(struct snd_cs4231 *chip);
125
David Howells7d12e782006-10-05 14:55:46 +0100126irqreturn_t snd_cs4231_interrupt(int irq, void *dev_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100128const char *snd_cs4231_chip_id(struct snd_cs4231 *chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100130int snd_cs4231_create(struct snd_card *card,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 unsigned long port,
132 unsigned long cport,
133 int irq, int dma1, int dma2,
134 unsigned short hardware,
135 unsigned short hwshare,
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100136 struct snd_cs4231 ** rchip);
137int snd_cs4231_pcm(struct snd_cs4231 * chip, int device, struct snd_pcm **rpcm);
138int snd_cs4231_timer(struct snd_cs4231 * chip, int device, struct snd_timer **rtimer);
139int snd_cs4231_mixer(struct snd_cs4231 * chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100141int snd_cs4236_create(struct snd_card *card,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 unsigned long port,
143 unsigned long cport,
144 int irq, int dma1, int dma2,
145 unsigned short hardware,
146 unsigned short hwshare,
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100147 struct snd_cs4231 ** rchip);
148int snd_cs4236_pcm(struct snd_cs4231 * chip, int device, struct snd_pcm **rpcm);
149int snd_cs4236_mixer(struct snd_cs4231 * chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
151/*
152 * mixer library
153 */
154
155#define CS4231_SINGLE(xname, xindex, reg, shift, mask, invert) \
156{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
157 .info = snd_cs4231_info_single, \
158 .get = snd_cs4231_get_single, .put = snd_cs4231_put_single, \
159 .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }
160
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100161int snd_cs4231_info_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo);
162int snd_cs4231_get_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
163int snd_cs4231_put_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
165#define CS4231_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
166{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
167 .info = snd_cs4231_info_double, \
168 .get = snd_cs4231_get_double, .put = snd_cs4231_put_double, \
169 .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }
170
Takashi Iwaiba2375a2005-11-17 14:30:42 +0100171int snd_cs4231_info_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo);
172int snd_cs4231_get_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
173int snd_cs4231_put_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175#endif /* __SOUND_CS4231_H */