blob: c500d48ea349915ded4fc786b09171fcdcd00054 [file] [log] [blame]
Clemens Ladischd0ce9942007-12-23 19:50:57 +01001#ifndef OXYGEN_H_INCLUDED
2#define OXYGEN_H_INCLUDED
3
4#include <linux/mutex.h>
5#include <linux/spinlock.h>
Clemens Ladisch1e821dd2008-01-28 08:34:21 +01006#include <linux/wait.h>
Clemens Ladischd0ce9942007-12-23 19:50:57 +01007#include <linux/workqueue.h>
8#include "oxygen_regs.h"
9
10/* 1 << PCM_x == OXYGEN_CHANNEL_x */
11#define PCM_A 0
12#define PCM_B 1
13#define PCM_C 2
14#define PCM_SPDIF 3
15#define PCM_MULTICH 4
16#define PCM_AC97 5
17#define PCM_COUNT 6
18
Clemens Ladischc1365002008-05-13 09:19:53 +020019#define OXYGEN_IO_SIZE 0x100
20
Clemens Ladischf009ad92008-03-19 08:19:41 +010021/* model-specific configuration of outputs/inputs */
Clemens Ladischdbbbd672008-09-22 09:03:42 +020022#define PLAYBACK_0_TO_I2S 0x0001
23 /* PLAYBACK_0_TO_AC97_0 not implemented */
24#define PLAYBACK_1_TO_SPDIF 0x0004
25#define PLAYBACK_2_TO_AC97_1 0x0008
26#define CAPTURE_0_FROM_I2S_1 0x0010
27#define CAPTURE_0_FROM_I2S_2 0x0020
28 /* CAPTURE_0_FROM_AC97_0 not implemented */
29#define CAPTURE_1_FROM_SPDIF 0x0080
30#define CAPTURE_2_FROM_I2S_2 0x0100
31#define CAPTURE_2_FROM_AC97_1 0x0200
32 /* CAPTURE_3_FROM_I2S_3 not implemented */
33#define MIDI_OUTPUT 0x0800
34#define MIDI_INPUT 0x1000
Clemens Ladischf009ad92008-03-19 08:19:41 +010035
Clemens Ladisch01a3aff2008-01-14 08:56:01 +010036enum {
37 CONTROL_SPDIF_PCM,
38 CONTROL_SPDIF_INPUT_BITS,
Clemens Ladisch893e44b2008-01-14 08:57:05 +010039 CONTROL_MIC_CAPTURE_SWITCH,
40 CONTROL_LINE_CAPTURE_SWITCH,
41 CONTROL_CD_CAPTURE_SWITCH,
42 CONTROL_AUX_CAPTURE_SWITCH,
Clemens Ladisch01a3aff2008-01-14 08:56:01 +010043 CONTROL_COUNT
44};
45
Clemens Ladischd0ce9942007-12-23 19:50:57 +010046#define OXYGEN_PCI_SUBID(sv, sd) \
47 .vendor = PCI_VENDOR_ID_CMEDIA, \
48 .device = 0x8788, \
49 .subvendor = sv, \
50 .subdevice = sd
51
Clemens Ladisch30459d72009-02-19 08:42:44 +010052#define BROKEN_EEPROM_DRIVER_DATA ((unsigned long)-1)
53#define OXYGEN_PCI_SUBID_BROKEN_EEPROM \
54 OXYGEN_PCI_SUBID(PCI_VENDOR_ID_CMEDIA, 0x8788), \
55 .driver_data = BROKEN_EEPROM_DRIVER_DATA
56
Clemens Ladischd0ce9942007-12-23 19:50:57 +010057struct pci_dev;
Clemens Ladisch30459d72009-02-19 08:42:44 +010058struct pci_device_id;
Clemens Ladischd0ce9942007-12-23 19:50:57 +010059struct snd_card;
60struct snd_pcm_substream;
Clemens Ladisch747c6012008-01-16 08:32:53 +010061struct snd_pcm_hardware;
Clemens Ladischd0ce9942007-12-23 19:50:57 +010062struct snd_pcm_hw_params;
Clemens Ladischccc80fb2008-01-16 08:32:08 +010063struct snd_kcontrol_new;
Clemens Ladischd0ce9942007-12-23 19:50:57 +010064struct snd_rawmidi;
Clemens Ladisch9bd6a732008-09-22 08:55:19 +020065struct oxygen;
Clemens Ladischd0ce9942007-12-23 19:50:57 +010066
67struct oxygen_model {
68 const char *shortname;
69 const char *longname;
70 const char *chip;
Clemens Ladischd0ce9942007-12-23 19:50:57 +010071 void (*init)(struct oxygen *chip);
Clemens Ladischccc80fb2008-01-16 08:32:08 +010072 int (*control_filter)(struct snd_kcontrol_new *template);
Clemens Ladischd0ce9942007-12-23 19:50:57 +010073 int (*mixer_init)(struct oxygen *chip);
74 void (*cleanup)(struct oxygen *chip);
Clemens Ladisch4a4bc532008-05-13 09:24:39 +020075 void (*suspend)(struct oxygen *chip);
76 void (*resume)(struct oxygen *chip);
Clemens Ladisch747c6012008-01-16 08:32:53 +010077 void (*pcm_hardware_filter)(unsigned int channel,
78 struct snd_pcm_hardware *hardware);
Clemens Ladischd0ce9942007-12-23 19:50:57 +010079 void (*set_dac_params)(struct oxygen *chip,
80 struct snd_pcm_hw_params *params);
81 void (*set_adc_params)(struct oxygen *chip,
82 struct snd_pcm_hw_params *params);
83 void (*update_dac_volume)(struct oxygen *chip);
84 void (*update_dac_mute)(struct oxygen *chip);
Clemens Ladisch7c014152008-01-28 08:36:55 +010085 void (*gpio_changed)(struct oxygen *chip);
Clemens Ladisch397b1dc2008-09-22 09:04:43 +020086 void (*uart_input)(struct oxygen *chip);
Clemens Ladisch11864b42008-04-09 09:16:14 +020087 void (*ac97_switch)(struct oxygen *chip,
88 unsigned int reg, unsigned int mute);
Clemens Ladisch4972a172008-04-16 09:15:45 +020089 const unsigned int *dac_tlv;
Clemens Ladisch30459d72009-02-19 08:42:44 +010090 unsigned long private_data;
Clemens Ladisch7ef37cd2008-01-21 08:51:55 +010091 size_t model_data_size;
Clemens Ladischd76596b2008-09-22 09:02:08 +020092 unsigned int device_config;
Clemens Ladisch976cd622008-01-25 08:37:49 +010093 u8 dac_channels;
Clemens Ladisch193e8132008-04-16 09:13:36 +020094 u8 dac_volume_min;
95 u8 dac_volume_max;
Clemens Ladischdb12b8e2008-03-19 08:20:59 +010096 u8 misc_flags;
Clemens Ladisch84aa6b72008-01-16 08:28:54 +010097 u8 function_flags;
Clemens Ladisch05855ba2008-01-17 09:05:09 +010098 u16 dac_i2s_format;
99 u16 adc_i2s_format;
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100100};
101
Clemens Ladisch9bd6a732008-09-22 08:55:19 +0200102struct oxygen {
103 unsigned long addr;
104 spinlock_t reg_lock;
105 struct mutex mutex;
106 struct snd_card *card;
107 struct pci_dev *pci;
108 struct snd_rawmidi *midi;
109 int irq;
110 void *model_data;
111 unsigned int interrupt_mask;
112 u8 dac_volume[8];
113 u8 dac_mute;
114 u8 pcm_active;
115 u8 pcm_running;
116 u8 dac_routing;
117 u8 spdif_playback_enable;
118 u8 revision;
119 u8 has_ac97_0;
120 u8 has_ac97_1;
121 u32 spdif_bits;
122 u32 spdif_pcm_bits;
123 struct snd_pcm_substream *streams[PCM_COUNT];
124 struct snd_kcontrol *controls[CONTROL_COUNT];
125 struct work_struct spdif_input_bits_work;
126 struct work_struct gpio_work;
127 wait_queue_head_t ac97_waitqueue;
128 union {
129 u8 _8[OXYGEN_IO_SIZE];
130 __le16 _16[OXYGEN_IO_SIZE / 2];
131 __le32 _32[OXYGEN_IO_SIZE / 4];
132 } saved_registers;
133 u16 saved_ac97_registers[2][0x40];
Clemens Ladisch397b1dc2008-09-22 09:04:43 +0200134 unsigned int uart_input_count;
135 u8 uart_input[32];
Clemens Ladisch9bd6a732008-09-22 08:55:19 +0200136 struct oxygen_model model;
137};
138
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100139/* oxygen_lib.c */
140
Clemens Ladischdb12b8e2008-03-19 08:20:59 +0100141int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
Clemens Ladischbb718582009-02-19 08:37:13 +0100142 struct module *owner,
Clemens Ladisch30459d72009-02-19 08:42:44 +0100143 const struct pci_device_id *ids,
144 int (*get_model)(struct oxygen *chip,
145 const struct pci_device_id *id
146 )
147 );
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100148void oxygen_pci_remove(struct pci_dev *pci);
Clemens Ladisch4a4bc532008-05-13 09:24:39 +0200149#ifdef CONFIG_PM
150int oxygen_pci_suspend(struct pci_dev *pci, pm_message_t state);
151int oxygen_pci_resume(struct pci_dev *pci);
152#endif
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100153
154/* oxygen_mixer.c */
155
156int oxygen_mixer_init(struct oxygen *chip);
157void oxygen_update_dac_routing(struct oxygen *chip);
158void oxygen_update_spdif_source(struct oxygen *chip);
159
160/* oxygen_pcm.c */
161
162int oxygen_pcm_init(struct oxygen *chip);
163
164/* oxygen_io.c */
165
166u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
167u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
168u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
169void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
170void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
171void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
172void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
173 u8 value, u8 mask);
174void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
175 u16 value, u16 mask);
176void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
177 u32 value, u32 mask);
178
179u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
180 unsigned int index);
181void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
182 unsigned int index, u16 data);
183void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
184 unsigned int index, u16 data, u16 mask);
185
186void oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);
Clemens Ladisch10e6d5f2008-04-07 10:23:37 +0200187void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data);
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100188
Clemens Ladisch397b1dc2008-09-22 09:04:43 +0200189void oxygen_reset_uart(struct oxygen *chip);
190void oxygen_write_uart(struct oxygen *chip, u8 data);
191
Clemens Ladisch30459d72009-02-19 08:42:44 +0100192u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index);
193
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100194static inline void oxygen_set_bits8(struct oxygen *chip,
195 unsigned int reg, u8 value)
196{
197 oxygen_write8_masked(chip, reg, value, value);
198}
199
200static inline void oxygen_set_bits16(struct oxygen *chip,
201 unsigned int reg, u16 value)
202{
203 oxygen_write16_masked(chip, reg, value, value);
204}
205
206static inline void oxygen_set_bits32(struct oxygen *chip,
207 unsigned int reg, u32 value)
208{
209 oxygen_write32_masked(chip, reg, value, value);
210}
211
212static inline void oxygen_clear_bits8(struct oxygen *chip,
213 unsigned int reg, u8 value)
214{
215 oxygen_write8_masked(chip, reg, 0, value);
216}
217
218static inline void oxygen_clear_bits16(struct oxygen *chip,
219 unsigned int reg, u16 value)
220{
221 oxygen_write16_masked(chip, reg, 0, value);
222}
223
224static inline void oxygen_clear_bits32(struct oxygen *chip,
225 unsigned int reg, u32 value)
226{
227 oxygen_write32_masked(chip, reg, 0, value);
228}
229
230static inline void oxygen_ac97_set_bits(struct oxygen *chip, unsigned int codec,
231 unsigned int index, u16 value)
232{
233 oxygen_write_ac97_masked(chip, codec, index, value, value);
234}
235
236static inline void oxygen_ac97_clear_bits(struct oxygen *chip,
237 unsigned int codec,
238 unsigned int index, u16 value)
239{
240 oxygen_write_ac97_masked(chip, codec, index, 0, value);
241}
242
243#endif