Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / e96f38f732d24515792296b3738842934c985539 / . / sound / pci / oxygen / oxygen.h
blob: cf9054ecb97b8566e66b3b9ba7d5f055c539aca0 [file] [log] [blame]
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]1#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 +0100[diff] [blame]6#include <linux/wait.h>
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]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
Clemens Ladischc1365002008-05-13 09:19:53 +0200[diff] [blame]19#define OXYGEN_IO_SIZE 0x100
20
Clemens Ladisch1275d6f2009-02-19 08:44:12 +0100[diff] [blame]21#define OXYGEN_EEPROM_ID 0x434d /* "CM" */
22
Clemens Ladischf009ad92008-03-19 08:19:41 +0100[diff] [blame]23/* model-specific configuration of outputs/inputs */
Clemens Ladischdbbbd672008-09-22 09:03:42 +0200[diff] [blame]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
Clemens Ladischb6ca8ab2010-10-04 13:21:52 +0200[diff] [blame]37#define AC97_CD_INPUT 0x2000
Clemens Ladische96f38f2010-12-02 11:39:34 +0100[diff] [blame^]38#define AC97_FMIC_SWITCH 0x4000
Clemens Ladischf009ad92008-03-19 08:19:41 +0100[diff] [blame]39
Clemens Ladisch01a3aff2008-01-14 08:56:01 +0100[diff] [blame]40enum {
41 CONTROL_SPDIF_PCM,
42 CONTROL_SPDIF_INPUT_BITS,
Clemens Ladisch893e44b2008-01-14 08:57:05 +0100[diff] [blame]43 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 +0100[diff] [blame]47 CONTROL_COUNT
48};
49
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]50#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 +0100[diff] [blame]56#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 +0100[diff] [blame]61struct pci_dev;
Clemens Ladisch30459d72009-02-19 08:42:44 +0100[diff] [blame]62struct pci_device_id;
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]63struct snd_card;
64struct snd_pcm_substream;
Clemens Ladisch747c6012008-01-16 08:32:53 +0100[diff] [blame]65struct snd_pcm_hardware;
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]66struct snd_pcm_hw_params;
Clemens Ladischccc80fb2008-01-16 08:32:08 +0100[diff] [blame]67struct snd_kcontrol_new;
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]68struct snd_rawmidi;
Clemens Ladisch9bd6a732008-09-22 08:55:19 +0200[diff] [blame]69struct oxygen;
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]70
71struct oxygen_model {
72 const char *shortname;
73 const char *longname;
74 const char *chip;
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]75 void (*init)(struct oxygen *chip);
Clemens Ladischccc80fb2008-01-16 08:32:08 +0100[diff] [blame]76 int (*control_filter)(struct snd_kcontrol_new *template);
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]77 int (*mixer_init)(struct oxygen *chip);
78 void (*cleanup)(struct oxygen *chip);
Clemens Ladisch4a4bc532008-05-13 09:24:39 +0200[diff] [blame]79 void (*suspend)(struct oxygen *chip);
80 void (*resume)(struct oxygen *chip);
Clemens Ladisch747c6012008-01-16 08:32:53 +0100[diff] [blame]81 void (*pcm_hardware_filter)(unsigned int channel,
82 struct snd_pcm_hardware *hardware);
Clemens Ladisch76ffe1e2009-09-28 11:20:11 +0200[diff] [blame]83 unsigned int (*get_i2s_mclk)(struct oxygen *chip, unsigned int channel,
84 struct snd_pcm_hw_params *hw_params);
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]85 void (*set_dac_params)(struct oxygen *chip,
86 struct snd_pcm_hw_params *params);
87 void (*set_adc_params)(struct oxygen *chip,
88 struct snd_pcm_hw_params *params);
89 void (*update_dac_volume)(struct oxygen *chip);
90 void (*update_dac_mute)(struct oxygen *chip);
Clemens Ladisch3d8bb452009-09-28 11:16:41 +0200[diff] [blame]91 void (*update_center_lfe_mix)(struct oxygen *chip, bool mixed);
Clemens Ladisch7c014152008-01-28 08:36:55 +0100[diff] [blame]92 void (*gpio_changed)(struct oxygen *chip);
Clemens Ladisch397b1dc2008-09-22 09:04:43 +0200[diff] [blame]93 void (*uart_input)(struct oxygen *chip);
Clemens Ladisch11864b42008-04-09 09:16:14 +0200[diff] [blame]94 void (*ac97_switch)(struct oxygen *chip,
95 unsigned int reg, unsigned int mute);
Clemens Ladisch4972a172008-04-16 09:15:45 +0200[diff] [blame]96 const unsigned int *dac_tlv;
Clemens Ladisch30459d72009-02-19 08:42:44 +0100[diff] [blame]97 unsigned long private_data;
Clemens Ladisch7ef37cd2008-01-21 08:51:55 +0100[diff] [blame]98 size_t model_data_size;
Clemens Ladischd76596b2008-09-22 09:02:08 +0200[diff] [blame]99 unsigned int device_config;
Clemens Ladisch976cd622008-01-25 08:37:49 +0100[diff] [blame]100 u8 dac_channels;
Clemens Ladisch193e8132008-04-16 09:13:36 +0200[diff] [blame]101 u8 dac_volume_min;
102 u8 dac_volume_max;
Clemens Ladischdb12b8e2008-03-19 08:20:59 +0100[diff] [blame]103 u8 misc_flags;
Clemens Ladisch84aa6b72008-01-16 08:28:54 +0100[diff] [blame]104 u8 function_flags;
Clemens Ladisch05855ba2008-01-17 09:05:09 +0100[diff] [blame]105 u16 dac_i2s_format;
106 u16 adc_i2s_format;
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]107};
108
Clemens Ladisch9bd6a732008-09-22 08:55:19 +0200[diff] [blame]109struct oxygen {
110 unsigned long addr;
111 spinlock_t reg_lock;
112 struct mutex mutex;
113 struct snd_card *card;
114 struct pci_dev *pci;
115 struct snd_rawmidi *midi;
116 int irq;
117 void *model_data;
118 unsigned int interrupt_mask;
119 u8 dac_volume[8];
120 u8 dac_mute;
121 u8 pcm_active;
122 u8 pcm_running;
123 u8 dac_routing;
124 u8 spdif_playback_enable;
125 u8 revision;
126 u8 has_ac97_0;
127 u8 has_ac97_1;
128 u32 spdif_bits;
129 u32 spdif_pcm_bits;
130 struct snd_pcm_substream *streams[PCM_COUNT];
131 struct snd_kcontrol *controls[CONTROL_COUNT];
132 struct work_struct spdif_input_bits_work;
133 struct work_struct gpio_work;
134 wait_queue_head_t ac97_waitqueue;
135 union {
136 u8 _8[OXYGEN_IO_SIZE];
137 __le16 _16[OXYGEN_IO_SIZE / 2];
138 __le32 _32[OXYGEN_IO_SIZE / 4];
139 } saved_registers;
140 u16 saved_ac97_registers[2][0x40];
Clemens Ladisch397b1dc2008-09-22 09:04:43 +0200[diff] [blame]141 unsigned int uart_input_count;
142 u8 uart_input[32];
Clemens Ladisch9bd6a732008-09-22 08:55:19 +0200[diff] [blame]143 struct oxygen_model model;
144};
145
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]146/* oxygen_lib.c */
147
Clemens Ladischdb12b8e2008-03-19 08:20:59 +0100[diff] [blame]148int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
Clemens Ladischbb718582009-02-19 08:37:13 +0100[diff] [blame]149 struct module *owner,
Clemens Ladisch30459d72009-02-19 08:42:44 +0100[diff] [blame]150 const struct pci_device_id *ids,
151 int (*get_model)(struct oxygen *chip,
152 const struct pci_device_id *id
153 )
154 );
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]155void oxygen_pci_remove(struct pci_dev *pci);
Clemens Ladisch4a4bc532008-05-13 09:24:39 +0200[diff] [blame]156#ifdef CONFIG_PM
157int oxygen_pci_suspend(struct pci_dev *pci, pm_message_t state);
158int oxygen_pci_resume(struct pci_dev *pci);
159#endif
Clemens Ladisch4c25b932010-09-07 13:37:10 +0200[diff] [blame]160void oxygen_pci_shutdown(struct pci_dev *pci);
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]161
162/* oxygen_mixer.c */
163
164int oxygen_mixer_init(struct oxygen *chip);
165void oxygen_update_dac_routing(struct oxygen *chip);
166void oxygen_update_spdif_source(struct oxygen *chip);
167
168/* oxygen_pcm.c */
169
170int oxygen_pcm_init(struct oxygen *chip);
Clemens Ladisch76ffe1e2009-09-28 11:20:11 +0200[diff] [blame]171unsigned int oxygen_default_i2s_mclk(struct oxygen *chip, unsigned int channel,
172 struct snd_pcm_hw_params *hw_params);
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]173
174/* oxygen_io.c */
175
176u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
177u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
178u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
179void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
180void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
181void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
182void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
183 u8 value, u8 mask);
184void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
185 u16 value, u16 mask);
186void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
187 u32 value, u32 mask);
188
189u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
190 unsigned int index);
191void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
192 unsigned int index, u16 data);
193void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
194 unsigned int index, u16 data, u16 mask);
195
196void oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);
Clemens Ladisch10e6d5f2008-04-07 10:23:37 +0200[diff] [blame]197void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data);
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]198
Clemens Ladisch397b1dc2008-09-22 09:04:43 +0200[diff] [blame]199void oxygen_reset_uart(struct oxygen *chip);
200void oxygen_write_uart(struct oxygen *chip, u8 data);
201
Clemens Ladisch30459d72009-02-19 08:42:44 +0100[diff] [blame]202u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index);
Clemens Ladisch1275d6f2009-02-19 08:44:12 +0100[diff] [blame]203void oxygen_write_eeprom(struct oxygen *chip, unsigned int index, u16 value);
Clemens Ladisch30459d72009-02-19 08:42:44 +0100[diff] [blame]204
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]205static inline void oxygen_set_bits8(struct oxygen *chip,
206 unsigned int reg, u8 value)
207{
208 oxygen_write8_masked(chip, reg, value, value);
209}
210
211static inline void oxygen_set_bits16(struct oxygen *chip,
212 unsigned int reg, u16 value)
213{
214 oxygen_write16_masked(chip, reg, value, value);
215}
216
217static inline void oxygen_set_bits32(struct oxygen *chip,
218 unsigned int reg, u32 value)
219{
220 oxygen_write32_masked(chip, reg, value, value);
221}
222
223static inline void oxygen_clear_bits8(struct oxygen *chip,
224 unsigned int reg, u8 value)
225{
226 oxygen_write8_masked(chip, reg, 0, value);
227}
228
229static inline void oxygen_clear_bits16(struct oxygen *chip,
230 unsigned int reg, u16 value)
231{
232 oxygen_write16_masked(chip, reg, 0, value);
233}
234
235static inline void oxygen_clear_bits32(struct oxygen *chip,
236 unsigned int reg, u32 value)
237{
238 oxygen_write32_masked(chip, reg, 0, value);
239}
240
241static inline void oxygen_ac97_set_bits(struct oxygen *chip, unsigned int codec,
242 unsigned int index, u16 value)
243{
244 oxygen_write_ac97_masked(chip, codec, index, value, value);
245}
246
247static inline void oxygen_ac97_clear_bits(struct oxygen *chip,
248 unsigned int codec,
249 unsigned int index, u16 value)
250{
251 oxygen_write_ac97_masked(chip, codec, index, 0, value);
252}
253
254#endif