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