blob: 70eff3747158e6480fd5e93b4f5afcfd9b844dbc [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 Ladisch1275d6f2009-02-19 08:44:12 +010021#define OXYGEN_EEPROM_ID 0x434d /* "CM" */
22
Clemens Ladischf009ad92008-03-19 08:19:41 +010023/* model-specific configuration of outputs/inputs */
Clemens Ladischdbbbd672008-09-22 09:03:42 +020024#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
Clemens Ladischb6ca8ab2010-10-04 13:21:52 +020037#define AC97_CD_INPUT 0x2000
Clemens Ladische96f38f2010-12-02 11:39:34 +010038#define AC97_FMIC_SWITCH 0x4000
Clemens Ladischf009ad92008-03-19 08:19:41 +010039
Clemens Ladisch01a3aff2008-01-14 08:56:01 +010040enum {
41 CONTROL_SPDIF_PCM,
42 CONTROL_SPDIF_INPUT_BITS,
Clemens Ladisch893e44b2008-01-14 08:57:05 +010043 CONTROL_MIC_CAPTURE_SWITCH,
44 CONTROL_LINE_CAPTURE_SWITCH,
45 CONTROL_CD_CAPTURE_SWITCH,
46 CONTROL_AUX_CAPTURE_SWITCH,
Clemens Ladisch01a3aff2008-01-14 08:56:01 +010047 CONTROL_COUNT
48};
49
Clemens Ladischd0ce9942007-12-23 19:50:57 +010050#define OXYGEN_PCI_SUBID(sv, sd) \
51 .vendor = PCI_VENDOR_ID_CMEDIA, \
52 .device = 0x8788, \
53 .subvendor = sv, \
54 .subdevice = sd
55
Clemens Ladisch30459d72009-02-19 08:42:44 +010056#define BROKEN_EEPROM_DRIVER_DATA ((unsigned long)-1)
57#define OXYGEN_PCI_SUBID_BROKEN_EEPROM \
58 OXYGEN_PCI_SUBID(PCI_VENDOR_ID_CMEDIA, 0x8788), \
59 .driver_data = BROKEN_EEPROM_DRIVER_DATA
60
Clemens Ladischd0ce9942007-12-23 19:50:57 +010061struct pci_dev;
Clemens Ladisch30459d72009-02-19 08:42:44 +010062struct pci_device_id;
Clemens Ladischd0ce9942007-12-23 19:50:57 +010063struct snd_card;
64struct snd_pcm_substream;
Clemens Ladisch747c6012008-01-16 08:32:53 +010065struct snd_pcm_hardware;
Clemens Ladischd0ce9942007-12-23 19:50:57 +010066struct snd_pcm_hw_params;
Clemens Ladischccc80fb2008-01-16 08:32:08 +010067struct snd_kcontrol_new;
Clemens Ladischd0ce9942007-12-23 19:50:57 +010068struct snd_rawmidi;
Clemens Ladisch9719fca2010-12-02 11:41:10 +010069struct snd_info_buffer;
Clemens Ladisch9bd6a732008-09-22 08:55:19 +020070struct oxygen;
Clemens Ladischd0ce9942007-12-23 19:50:57 +010071
72struct oxygen_model {
73 const char *shortname;
74 const char *longname;
75 const char *chip;
Clemens Ladischd0ce9942007-12-23 19:50:57 +010076 void (*init)(struct oxygen *chip);
Clemens Ladischccc80fb2008-01-16 08:32:08 +010077 int (*control_filter)(struct snd_kcontrol_new *template);
Clemens Ladischd0ce9942007-12-23 19:50:57 +010078 int (*mixer_init)(struct oxygen *chip);
79 void (*cleanup)(struct oxygen *chip);
Clemens Ladisch4a4bc532008-05-13 09:24:39 +020080 void (*suspend)(struct oxygen *chip);
81 void (*resume)(struct oxygen *chip);
Clemens Ladisch747c6012008-01-16 08:32:53 +010082 void (*pcm_hardware_filter)(unsigned int channel,
83 struct snd_pcm_hardware *hardware);
Clemens Ladisch76ffe1e2009-09-28 11:20:11 +020084 unsigned int (*get_i2s_mclk)(struct oxygen *chip, unsigned int channel,
85 struct snd_pcm_hw_params *hw_params);
Clemens Ladischd0ce9942007-12-23 19:50:57 +010086 void (*set_dac_params)(struct oxygen *chip,
87 struct snd_pcm_hw_params *params);
88 void (*set_adc_params)(struct oxygen *chip,
89 struct snd_pcm_hw_params *params);
90 void (*update_dac_volume)(struct oxygen *chip);
91 void (*update_dac_mute)(struct oxygen *chip);
Clemens Ladisch3d8bb452009-09-28 11:16:41 +020092 void (*update_center_lfe_mix)(struct oxygen *chip, bool mixed);
Clemens Ladisch7c014152008-01-28 08:36:55 +010093 void (*gpio_changed)(struct oxygen *chip);
Clemens Ladisch397b1dc2008-09-22 09:04:43 +020094 void (*uart_input)(struct oxygen *chip);
Clemens Ladisch11864b42008-04-09 09:16:14 +020095 void (*ac97_switch)(struct oxygen *chip,
96 unsigned int reg, unsigned int mute);
Clemens Ladisch9719fca2010-12-02 11:41:10 +010097 void (*dump_registers)(struct oxygen *chip,
98 struct snd_info_buffer *buffer);
Clemens Ladisch4972a172008-04-16 09:15:45 +020099 const unsigned int *dac_tlv;
Clemens Ladisch7ef37cd2008-01-21 08:51:55 +0100100 size_t model_data_size;
Clemens Ladischd76596b2008-09-22 09:02:08 +0200101 unsigned int device_config;
Clemens Ladisch1f4d7be2011-01-10 15:59:38 +0100102 u8 dac_channels_pcm;
103 u8 dac_channels_mixer;
Clemens Ladisch193e8132008-04-16 09:13:36 +0200104 u8 dac_volume_min;
105 u8 dac_volume_max;
Clemens Ladischdb12b8e2008-03-19 08:20:59 +0100106 u8 misc_flags;
Clemens Ladisch84aa6b72008-01-16 08:28:54 +0100107 u8 function_flags;
Clemens Ladisch05855ba2008-01-17 09:05:09 +0100108 u16 dac_i2s_format;
109 u16 adc_i2s_format;
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100110};
111
Clemens Ladisch9bd6a732008-09-22 08:55:19 +0200112struct oxygen {
113 unsigned long addr;
114 spinlock_t reg_lock;
115 struct mutex mutex;
116 struct snd_card *card;
117 struct pci_dev *pci;
118 struct snd_rawmidi *midi;
119 int irq;
120 void *model_data;
121 unsigned int interrupt_mask;
122 u8 dac_volume[8];
123 u8 dac_mute;
124 u8 pcm_active;
125 u8 pcm_running;
126 u8 dac_routing;
127 u8 spdif_playback_enable;
128 u8 revision;
129 u8 has_ac97_0;
130 u8 has_ac97_1;
131 u32 spdif_bits;
132 u32 spdif_pcm_bits;
133 struct snd_pcm_substream *streams[PCM_COUNT];
134 struct snd_kcontrol *controls[CONTROL_COUNT];
135 struct work_struct spdif_input_bits_work;
136 struct work_struct gpio_work;
137 wait_queue_head_t ac97_waitqueue;
138 union {
139 u8 _8[OXYGEN_IO_SIZE];
140 __le16 _16[OXYGEN_IO_SIZE / 2];
141 __le32 _32[OXYGEN_IO_SIZE / 4];
142 } saved_registers;
143 u16 saved_ac97_registers[2][0x40];
Clemens Ladisch397b1dc2008-09-22 09:04:43 +0200144 unsigned int uart_input_count;
145 u8 uart_input[32];
Clemens Ladisch9bd6a732008-09-22 08:55:19 +0200146 struct oxygen_model model;
147};
148
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100149/* oxygen_lib.c */
150
Clemens Ladischdb12b8e2008-03-19 08:20:59 +0100151int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
Clemens Ladischbb718582009-02-19 08:37:13 +0100152 struct module *owner,
Clemens Ladisch30459d72009-02-19 08:42:44 +0100153 const struct pci_device_id *ids,
154 int (*get_model)(struct oxygen *chip,
155 const struct pci_device_id *id
156 )
157 );
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100158void oxygen_pci_remove(struct pci_dev *pci);
Clemens Ladisch4a4bc532008-05-13 09:24:39 +0200159#ifdef CONFIG_PM
160int oxygen_pci_suspend(struct pci_dev *pci, pm_message_t state);
161int oxygen_pci_resume(struct pci_dev *pci);
162#endif
Clemens Ladisch4c25b932010-09-07 13:37:10 +0200163void oxygen_pci_shutdown(struct pci_dev *pci);
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100164
165/* oxygen_mixer.c */
166
167int oxygen_mixer_init(struct oxygen *chip);
168void oxygen_update_dac_routing(struct oxygen *chip);
169void oxygen_update_spdif_source(struct oxygen *chip);
170
171/* oxygen_pcm.c */
172
173int oxygen_pcm_init(struct oxygen *chip);
Clemens Ladisch76ffe1e2009-09-28 11:20:11 +0200174unsigned int oxygen_default_i2s_mclk(struct oxygen *chip, unsigned int channel,
175 struct snd_pcm_hw_params *hw_params);
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100176
177/* oxygen_io.c */
178
179u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
180u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
181u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
182void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
183void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
184void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
185void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
186 u8 value, u8 mask);
187void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
188 u16 value, u16 mask);
189void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
190 u32 value, u32 mask);
191
192u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
193 unsigned int index);
194void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
195 unsigned int index, u16 data);
196void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
197 unsigned int index, u16 data, u16 mask);
198
199void oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);
Clemens Ladisch10e6d5f2008-04-07 10:23:37 +0200200void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data);
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100201
Clemens Ladisch397b1dc2008-09-22 09:04:43 +0200202void oxygen_reset_uart(struct oxygen *chip);
203void oxygen_write_uart(struct oxygen *chip, u8 data);
204
Clemens Ladisch30459d72009-02-19 08:42:44 +0100205u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index);
Clemens Ladisch1275d6f2009-02-19 08:44:12 +0100206void oxygen_write_eeprom(struct oxygen *chip, unsigned int index, u16 value);
Clemens Ladisch30459d72009-02-19 08:42:44 +0100207
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100208static inline void oxygen_set_bits8(struct oxygen *chip,
209 unsigned int reg, u8 value)
210{
211 oxygen_write8_masked(chip, reg, value, value);
212}
213
214static inline void oxygen_set_bits16(struct oxygen *chip,
215 unsigned int reg, u16 value)
216{
217 oxygen_write16_masked(chip, reg, value, value);
218}
219
220static inline void oxygen_set_bits32(struct oxygen *chip,
221 unsigned int reg, u32 value)
222{
223 oxygen_write32_masked(chip, reg, value, value);
224}
225
226static inline void oxygen_clear_bits8(struct oxygen *chip,
227 unsigned int reg, u8 value)
228{
229 oxygen_write8_masked(chip, reg, 0, value);
230}
231
232static inline void oxygen_clear_bits16(struct oxygen *chip,
233 unsigned int reg, u16 value)
234{
235 oxygen_write16_masked(chip, reg, 0, value);
236}
237
238static inline void oxygen_clear_bits32(struct oxygen *chip,
239 unsigned int reg, u32 value)
240{
241 oxygen_write32_masked(chip, reg, 0, value);
242}
243
244static inline void oxygen_ac97_set_bits(struct oxygen *chip, unsigned int codec,
245 unsigned int index, u16 value)
246{
247 oxygen_write_ac97_masked(chip, codec, index, value, value);
248}
249
250static inline void oxygen_ac97_clear_bits(struct oxygen *chip,
251 unsigned int codec,
252 unsigned int index, u16 value)
253{
254 oxygen_write_ac97_masked(chip, codec, index, 0, value);
255}
256
257#endif