2ac3b3c8253f4d0d02473dd42af2b61a7af5ee4f
[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         void (*set_dac_params)(struct oxygen *chip,
82                                struct snd_pcm_hw_params *params);
83         void (*set_adc_params)(struct oxygen *chip,
84                                struct snd_pcm_hw_params *params);
85         void (*update_dac_volume)(struct oxygen *chip);
86         void (*update_dac_mute)(struct oxygen *chip);
87         void (*update_center_lfe_mix)(struct oxygen *chip, bool mixed);
88         void (*gpio_changed)(struct oxygen *chip);
89         void (*uart_input)(struct oxygen *chip);
90         void (*ac97_switch)(struct oxygen *chip,
91                             unsigned int reg, unsigned int mute);
92         const unsigned int *dac_tlv;
93         unsigned long private_data;
94         size_t model_data_size;
95         unsigned int device_config;
96         u8 dac_channels;
97         u8 dac_volume_min;
98         u8 dac_volume_max;
99         u8 misc_flags;
100         u8 function_flags;
101         u16 dac_i2s_format;
102         u16 adc_i2s_format;
103 };
104
105 struct oxygen {
106         unsigned long addr;
107         spinlock_t reg_lock;
108         struct mutex mutex;
109         struct snd_card *card;
110         struct pci_dev *pci;
111         struct snd_rawmidi *midi;
112         int irq;
113         void *model_data;
114         unsigned int interrupt_mask;
115         u8 dac_volume[8];
116         u8 dac_mute;
117         u8 pcm_active;
118         u8 pcm_running;
119         u8 dac_routing;
120         u8 spdif_playback_enable;
121         u8 revision;
122         u8 has_ac97_0;
123         u8 has_ac97_1;
124         u32 spdif_bits;
125         u32 spdif_pcm_bits;
126         struct snd_pcm_substream *streams[PCM_COUNT];
127         struct snd_kcontrol *controls[CONTROL_COUNT];
128         struct work_struct spdif_input_bits_work;
129         struct work_struct gpio_work;
130         wait_queue_head_t ac97_waitqueue;
131         union {
132                 u8 _8[OXYGEN_IO_SIZE];
133                 __le16 _16[OXYGEN_IO_SIZE / 2];
134                 __le32 _32[OXYGEN_IO_SIZE / 4];
135         } saved_registers;
136         u16 saved_ac97_registers[2][0x40];
137         unsigned int uart_input_count;
138         u8 uart_input[32];
139         struct oxygen_model model;
140 };
141
142 /* oxygen_lib.c */
143
144 int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
145                      struct module *owner,
146                      const struct pci_device_id *ids,
147                      int (*get_model)(struct oxygen *chip,
148                                       const struct pci_device_id *id
149                                      )
150                     );
151 void oxygen_pci_remove(struct pci_dev *pci);
152 #ifdef CONFIG_PM
153 int oxygen_pci_suspend(struct pci_dev *pci, pm_message_t state);
154 int oxygen_pci_resume(struct pci_dev *pci);
155 #endif
156
157 /* oxygen_mixer.c */
158
159 int oxygen_mixer_init(struct oxygen *chip);
160 void oxygen_update_dac_routing(struct oxygen *chip);
161 void oxygen_update_spdif_source(struct oxygen *chip);
162
163 /* oxygen_pcm.c */
164
165 int oxygen_pcm_init(struct oxygen *chip);
166
167 /* oxygen_io.c */
168
169 u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
170 u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
171 u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
172 void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
173 void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
174 void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
175 void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
176                           u8 value, u8 mask);
177 void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
178                            u16 value, u16 mask);
179 void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
180                            u32 value, u32 mask);
181
182 u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
183                      unsigned int index);
184 void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
185                        unsigned int index, u16 data);
186 void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
187                               unsigned int index, u16 data, u16 mask);
188
189 void oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);
190 void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data);
191
192 void oxygen_reset_uart(struct oxygen *chip);
193 void oxygen_write_uart(struct oxygen *chip, u8 data);
194
195 u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index);
196 void oxygen_write_eeprom(struct oxygen *chip, unsigned int index, u16 value);
197
198 static inline void oxygen_set_bits8(struct oxygen *chip,
199                                     unsigned int reg, u8 value)
200 {
201         oxygen_write8_masked(chip, reg, value, value);
202 }
203
204 static inline void oxygen_set_bits16(struct oxygen *chip,
205                                      unsigned int reg, u16 value)
206 {
207         oxygen_write16_masked(chip, reg, value, value);
208 }
209
210 static inline void oxygen_set_bits32(struct oxygen *chip,
211                                      unsigned int reg, u32 value)
212 {
213         oxygen_write32_masked(chip, reg, value, value);
214 }
215
216 static inline void oxygen_clear_bits8(struct oxygen *chip,
217                                       unsigned int reg, u8 value)
218 {
219         oxygen_write8_masked(chip, reg, 0, value);
220 }
221
222 static inline void oxygen_clear_bits16(struct oxygen *chip,
223                                        unsigned int reg, u16 value)
224 {
225         oxygen_write16_masked(chip, reg, 0, value);
226 }
227
228 static inline void oxygen_clear_bits32(struct oxygen *chip,
229                                        unsigned int reg, u32 value)
230 {
231         oxygen_write32_masked(chip, reg, 0, value);
232 }
233
234 static inline void oxygen_ac97_set_bits(struct oxygen *chip, unsigned int codec,
235                                         unsigned int index, u16 value)
236 {
237         oxygen_write_ac97_masked(chip, codec, index, value, value);
238 }
239
240 static inline void oxygen_ac97_clear_bits(struct oxygen *chip,
241                                           unsigned int codec,
242                                           unsigned int index, u16 value)
243 {
244         oxygen_write_ac97_masked(chip, codec, index, 0, value);
245 }
246
247 #endif