xref: /linux/sound/pci/oxygen/oxygen.h (revision 30459d7b)
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 /* model-specific configuration of outputs/inputs */
22 #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
35 
36 enum {
37 	CONTROL_SPDIF_PCM,
38 	CONTROL_SPDIF_INPUT_BITS,
39 	CONTROL_MIC_CAPTURE_SWITCH,
40 	CONTROL_LINE_CAPTURE_SWITCH,
41 	CONTROL_CD_CAPTURE_SWITCH,
42 	CONTROL_AUX_CAPTURE_SWITCH,
43 	CONTROL_COUNT
44 };
45 
46 #define OXYGEN_PCI_SUBID(sv, sd) \
47 	.vendor = PCI_VENDOR_ID_CMEDIA, \
48 	.device = 0x8788, \
49 	.subvendor = sv, \
50 	.subdevice = sd
51 
52 #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 
57 struct pci_dev;
58 struct pci_device_id;
59 struct snd_card;
60 struct snd_pcm_substream;
61 struct snd_pcm_hardware;
62 struct snd_pcm_hw_params;
63 struct snd_kcontrol_new;
64 struct snd_rawmidi;
65 struct oxygen;
66 
67 struct oxygen_model {
68 	const char *shortname;
69 	const char *longname;
70 	const char *chip;
71 	void (*init)(struct oxygen *chip);
72 	int (*control_filter)(struct snd_kcontrol_new *template);
73 	int (*mixer_init)(struct oxygen *chip);
74 	void (*cleanup)(struct oxygen *chip);
75 	void (*suspend)(struct oxygen *chip);
76 	void (*resume)(struct oxygen *chip);
77 	void (*pcm_hardware_filter)(unsigned int channel,
78 				    struct snd_pcm_hardware *hardware);
79 	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);
85 	void (*gpio_changed)(struct oxygen *chip);
86 	void (*uart_input)(struct oxygen *chip);
87 	void (*ac97_switch)(struct oxygen *chip,
88 			    unsigned int reg, unsigned int mute);
89 	const unsigned int *dac_tlv;
90 	unsigned long private_data;
91 	size_t model_data_size;
92 	unsigned int device_config;
93 	u8 dac_channels;
94 	u8 dac_volume_min;
95 	u8 dac_volume_max;
96 	u8 misc_flags;
97 	u8 function_flags;
98 	u16 dac_i2s_format;
99 	u16 adc_i2s_format;
100 };
101 
102 struct 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];
134 	unsigned int uart_input_count;
135 	u8 uart_input[32];
136 	struct oxygen_model model;
137 };
138 
139 /* oxygen_lib.c */
140 
141 int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
142 		     struct module *owner,
143 		     const struct pci_device_id *ids,
144 		     int (*get_model)(struct oxygen *chip,
145 				      const struct pci_device_id *id
146 				     )
147 		    );
148 void oxygen_pci_remove(struct pci_dev *pci);
149 #ifdef CONFIG_PM
150 int oxygen_pci_suspend(struct pci_dev *pci, pm_message_t state);
151 int oxygen_pci_resume(struct pci_dev *pci);
152 #endif
153 
154 /* oxygen_mixer.c */
155 
156 int oxygen_mixer_init(struct oxygen *chip);
157 void oxygen_update_dac_routing(struct oxygen *chip);
158 void oxygen_update_spdif_source(struct oxygen *chip);
159 
160 /* oxygen_pcm.c */
161 
162 int oxygen_pcm_init(struct oxygen *chip);
163 
164 /* oxygen_io.c */
165 
166 u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
167 u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
168 u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
169 void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
170 void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
171 void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
172 void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
173 			  u8 value, u8 mask);
174 void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
175 			   u16 value, u16 mask);
176 void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
177 			   u32 value, u32 mask);
178 
179 u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
180 		     unsigned int index);
181 void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
182 		       unsigned int index, u16 data);
183 void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
184 			      unsigned int index, u16 data, u16 mask);
185 
186 void oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);
187 void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data);
188 
189 void oxygen_reset_uart(struct oxygen *chip);
190 void oxygen_write_uart(struct oxygen *chip, u8 data);
191 
192 u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index);
193 
194 static 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 
200 static 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 
206 static 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 
212 static 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 
218 static 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 
224 static 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 
230 static 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 
236 static 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
244