sound: oxygen: allow custom MCLK rates
[safe/jmp/linux-2.6] / sound / pci / oxygen / oxygen.h
1 #ifndef OXYGEN_H_INCLUDED
2 #define OXYGEN_H_INCLUDED
3
4 #include <linux/mutex.h>
5 #include <linux/spinlock.h>
6 #include <linux/wait.h>
7 #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
19 #define OXYGEN_IO_SIZE  0x100
20
21 #define OXYGEN_EEPROM_ID        0x434d  /* "CM" */
22
23 /* model-specific configuration of outputs/inputs */
24 #define PLAYBACK_0_TO_I2S       0x0001
25      /* PLAYBACK_0_TO_AC97_0            not implemented */
26 #define PLAYBACK_1_TO_SPDIF     0x0004
27 #define PLAYBACK_2_TO_AC97_1    0x0008
28 #define CAPTURE_0_FROM_I2S_1    0x0010
29 #define CAPTURE_0_FROM_I2S_2    0x0020
30      /* CAPTURE_0_FROM_AC97_0           not implemented */
31 #define CAPTURE_1_FROM_SPDIF    0x0080
32 #define CAPTURE_2_FROM_I2S_2    0x0100
33 #define CAPTURE_2_FROM_AC97_1   0x0200
34      /* CAPTURE_3_FROM_I2S_3            not implemented */
35 #define MIDI_OUTPUT             0x0800
36 #define MIDI_INPUT              0x1000
37
38 enum {
39         CONTROL_SPDIF_PCM,
40         CONTROL_SPDIF_INPUT_BITS,
41         CONTROL_MIC_CAPTURE_SWITCH,
42         CONTROL_LINE_CAPTURE_SWITCH,
43         CONTROL_CD_CAPTURE_SWITCH,
44         CONTROL_AUX_CAPTURE_SWITCH,
45         CONTROL_COUNT
46 };
47
48 #define OXYGEN_PCI_SUBID(sv, sd) \
49         .vendor = PCI_VENDOR_ID_CMEDIA, \
50         .device = 0x8788, \
51         .subvendor = sv, \
52         .subdevice = sd
53
54 #define BROKEN_EEPROM_DRIVER_DATA ((unsigned long)-1)
55 #define OXYGEN_PCI_SUBID_BROKEN_EEPROM \
56         OXYGEN_PCI_SUBID(PCI_VENDOR_ID_CMEDIA, 0x8788), \
57         .driver_data = BROKEN_EEPROM_DRIVER_DATA
58
59 struct pci_dev;
60 struct pci_device_id;
61 struct snd_card;
62 struct snd_pcm_substream;
63 struct snd_pcm_hardware;
64 struct snd_pcm_hw_params;
65 struct snd_kcontrol_new;
66 struct snd_rawmidi;
67 struct oxygen;
68
69 struct oxygen_model {
70         const char *shortname;
71         const char *longname;
72         const char *chip;
73         void (*init)(struct oxygen *chip);
74         int (*control_filter)(struct snd_kcontrol_new *template);
75         int (*mixer_init)(struct oxygen *chip);
76         void (*cleanup)(struct oxygen *chip);
77         void (*suspend)(struct oxygen *chip);
78         void (*resume)(struct oxygen *chip);
79         void (*pcm_hardware_filter)(unsigned int channel,
80                                     struct snd_pcm_hardware *hardware);
81         unsigned int (*get_i2s_mclk)(struct oxygen *chip, unsigned int channel,
82                                      struct snd_pcm_hw_params *hw_params);
83         void (*set_dac_params)(struct oxygen *chip,
84                                struct snd_pcm_hw_params *params);
85         void (*set_adc_params)(struct oxygen *chip,
86                                struct snd_pcm_hw_params *params);
87         void (*update_dac_volume)(struct oxygen *chip);
88         void (*update_dac_mute)(struct oxygen *chip);
89         void (*update_center_lfe_mix)(struct oxygen *chip, bool mixed);
90         void (*gpio_changed)(struct oxygen *chip);
91         void (*uart_input)(struct oxygen *chip);
92         void (*ac97_switch)(struct oxygen *chip,
93                             unsigned int reg, unsigned int mute);
94         const unsigned int *dac_tlv;
95         unsigned long private_data;
96         size_t model_data_size;
97         unsigned int device_config;
98         u8 dac_channels;
99         u8 dac_volume_min;
100         u8 dac_volume_max;
101         u8 misc_flags;
102         u8 function_flags;
103         u16 dac_i2s_format;
104         u16 adc_i2s_format;
105 };
106
107 struct oxygen {
108         unsigned long addr;
109         spinlock_t reg_lock;
110         struct mutex mutex;
111         struct snd_card *card;
112         struct pci_dev *pci;
113         struct snd_rawmidi *midi;
114         int irq;
115         void *model_data;
116         unsigned int interrupt_mask;
117         u8 dac_volume[8];
118         u8 dac_mute;
119         u8 pcm_active;
120         u8 pcm_running;
121         u8 dac_routing;
122         u8 spdif_playback_enable;
123         u8 revision;
124         u8 has_ac97_0;
125         u8 has_ac97_1;
126         u32 spdif_bits;
127         u32 spdif_pcm_bits;
128         struct snd_pcm_substream *streams[PCM_COUNT];
129         struct snd_kcontrol *controls[CONTROL_COUNT];
130         struct work_struct spdif_input_bits_work;
131         struct work_struct gpio_work;
132         wait_queue_head_t ac97_waitqueue;
133         union {
134                 u8 _8[OXYGEN_IO_SIZE];
135                 __le16 _16[OXYGEN_IO_SIZE / 2];
136                 __le32 _32[OXYGEN_IO_SIZE / 4];
137         } saved_registers;
138         u16 saved_ac97_registers[2][0x40];
139         unsigned int uart_input_count;
140         u8 uart_input[32];
141         struct oxygen_model model;
142 };
143
144 /* oxygen_lib.c */
145
146 int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
147                      struct module *owner,
148                      const struct pci_device_id *ids,
149                      int (*get_model)(struct oxygen *chip,
150                                       const struct pci_device_id *id
151                                      )
152                     );
153 void oxygen_pci_remove(struct pci_dev *pci);
154 #ifdef CONFIG_PM
155 int oxygen_pci_suspend(struct pci_dev *pci, pm_message_t state);
156 int oxygen_pci_resume(struct pci_dev *pci);
157 #endif
158
159 /* oxygen_mixer.c */
160
161 int oxygen_mixer_init(struct oxygen *chip);
162 void oxygen_update_dac_routing(struct oxygen *chip);
163 void oxygen_update_spdif_source(struct oxygen *chip);
164
165 /* oxygen_pcm.c */
166
167 int oxygen_pcm_init(struct oxygen *chip);
168 unsigned int oxygen_default_i2s_mclk(struct oxygen *chip, unsigned int channel,
169                                      struct snd_pcm_hw_params *hw_params);
170
171 /* oxygen_io.c */
172
173 u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
174 u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
175 u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
176 void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
177 void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
178 void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
179 void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
180                           u8 value, u8 mask);
181 void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
182                            u16 value, u16 mask);
183 void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
184                            u32 value, u32 mask);
185
186 u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
187                      unsigned int index);
188 void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
189                        unsigned int index, u16 data);
190 void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
191                               unsigned int index, u16 data, u16 mask);
192
193 void oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);
194 void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data);
195
196 void oxygen_reset_uart(struct oxygen *chip);
197 void oxygen_write_uart(struct oxygen *chip, u8 data);
198
199 u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index);
200 void oxygen_write_eeprom(struct oxygen *chip, unsigned int index, u16 value);
201
202 static inline void oxygen_set_bits8(struct oxygen *chip,
203                                     unsigned int reg, u8 value)
204 {
205         oxygen_write8_masked(chip, reg, value, value);
206 }
207
208 static inline void oxygen_set_bits16(struct oxygen *chip,
209                                      unsigned int reg, u16 value)
210 {
211         oxygen_write16_masked(chip, reg, value, value);
212 }
213
214 static inline void oxygen_set_bits32(struct oxygen *chip,
215                                      unsigned int reg, u32 value)
216 {
217         oxygen_write32_masked(chip, reg, value, value);
218 }
219
220 static inline void oxygen_clear_bits8(struct oxygen *chip,
221                                       unsigned int reg, u8 value)
222 {
223         oxygen_write8_masked(chip, reg, 0, value);
224 }
225
226 static inline void oxygen_clear_bits16(struct oxygen *chip,
227                                        unsigned int reg, u16 value)
228 {
229         oxygen_write16_masked(chip, reg, 0, value);
230 }
231
232 static inline void oxygen_clear_bits32(struct oxygen *chip,
233                                        unsigned int reg, u32 value)
234 {
235         oxygen_write32_masked(chip, reg, 0, value);
236 }
237
238 static inline void oxygen_ac97_set_bits(struct oxygen *chip, unsigned int codec,
239                                         unsigned int index, u16 value)
240 {
241         oxygen_write_ac97_masked(chip, codec, index, value, value);
242 }
243
244 static inline void oxygen_ac97_clear_bits(struct oxygen *chip,
245                                           unsigned int codec,
246                                           unsigned int index, u16 value)
247 {
248         oxygen_write_ac97_masked(chip, codec, index, 0, value);
249 }
250
251 #endif