Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.9 / refs/tags/FP3-REL-Q-3.A.0107 / . / sound / pci / oxygen / oxygen.h
blob: 293d0b9a50c3fbdde4ec73a93939b80286dc648d [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
Clemens Ladisch0902fbb2015-01-16 22:15:13 +0100[diff] [blame]38#define CAPTURE_3_FROM_I2S_3 0x0400
Clemens Ladischdbbbd672008-09-22 09:03:42 +0200[diff] [blame]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 Ladischefbeb072011-01-31 11:47:52 +0100[diff] [blame]95 unsigned int (*adjust_dac_routing)(struct oxygen *chip,
96 unsigned int play_routing);
Clemens Ladisch7c014152008-01-28 08:36:55 +0100[diff] [blame]97 void (*gpio_changed)(struct oxygen *chip);
Clemens Ladisch397b1dc2008-09-22 09:04:43 +0200[diff] [blame]98 void (*uart_input)(struct oxygen *chip);
Clemens Ladisch11864b42008-04-09 09:16:14 +0200[diff] [blame]99 void (*ac97_switch)(struct oxygen *chip,
100 unsigned int reg, unsigned int mute);
Clemens Ladisch9719fca2010-12-02 11:41:10 +0100[diff] [blame]101 void (*dump_registers)(struct oxygen *chip,
102 struct snd_info_buffer *buffer);
Clemens Ladisch4972a172008-04-16 09:15:45 +0200[diff] [blame]103 const unsigned int *dac_tlv;
Clemens Ladisch7ef37cd2008-01-21 08:51:55 +0100[diff] [blame]104 size_t model_data_size;
Clemens Ladischd76596b2008-09-22 09:02:08 +0200[diff] [blame]105 unsigned int device_config;
Clemens Ladisch1f4d7be2011-01-10 15:59:38 +0100[diff] [blame]106 u8 dac_channels_pcm;
107 u8 dac_channels_mixer;
Clemens Ladisch193e8132008-04-16 09:13:36 +0200[diff] [blame]108 u8 dac_volume_min;
109 u8 dac_volume_max;
Clemens Ladischdb12b8e2008-03-19 08:20:59 +0100[diff] [blame]110 u8 misc_flags;
Clemens Ladisch84aa6b72008-01-16 08:28:54 +0100[diff] [blame]111 u8 function_flags;
Clemens Ladisch5b8bf2a2011-01-10 16:14:52 +0100[diff] [blame]112 u8 dac_mclks;
113 u8 adc_mclks;
Clemens Ladisch05855ba2008-01-17 09:05:09 +0100[diff] [blame]114 u16 dac_i2s_format;
115 u16 adc_i2s_format;
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]116};
117
Clemens Ladisch9bd6a732008-09-22 08:55:19 +0200[diff] [blame]118struct oxygen {
119 unsigned long addr;
120 spinlock_t reg_lock;
121 struct mutex mutex;
122 struct snd_card *card;
123 struct pci_dev *pci;
124 struct snd_rawmidi *midi;
125 int irq;
126 void *model_data;
127 unsigned int interrupt_mask;
128 u8 dac_volume[8];
129 u8 dac_mute;
130 u8 pcm_active;
131 u8 pcm_running;
132 u8 dac_routing;
133 u8 spdif_playback_enable;
Clemens Ladisch9bd6a732008-09-22 08:55:19 +0200[diff] [blame]134 u8 has_ac97_0;
135 u8 has_ac97_1;
136 u32 spdif_bits;
137 u32 spdif_pcm_bits;
138 struct snd_pcm_substream *streams[PCM_COUNT];
139 struct snd_kcontrol *controls[CONTROL_COUNT];
140 struct work_struct spdif_input_bits_work;
141 struct work_struct gpio_work;
142 wait_queue_head_t ac97_waitqueue;
143 union {
144 u8 _8[OXYGEN_IO_SIZE];
145 __le16 _16[OXYGEN_IO_SIZE / 2];
146 __le32 _32[OXYGEN_IO_SIZE / 4];
147 } saved_registers;
148 u16 saved_ac97_registers[2][0x40];
Clemens Ladisch397b1dc2008-09-22 09:04:43 +0200[diff] [blame]149 unsigned int uart_input_count;
150 u8 uart_input[32];
Clemens Ladisch9bd6a732008-09-22 08:55:19 +0200[diff] [blame]151 struct oxygen_model model;
152};
153
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]154/* oxygen_lib.c */
155
Clemens Ladischdb12b8e2008-03-19 08:20:59 +0100[diff] [blame]156int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
Clemens Ladischbb718582009-02-19 08:37:13 +0100[diff] [blame]157 struct module *owner,
Clemens Ladisch30459d72009-02-19 08:42:44 +0100[diff] [blame]158 const struct pci_device_id *ids,
159 int (*get_model)(struct oxygen *chip,
160 const struct pci_device_id *id
161 )
162 );
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]163void oxygen_pci_remove(struct pci_dev *pci);
Takashi Iwaic7561cd2012-08-14 18:12:04 +0200[diff] [blame]164#ifdef CONFIG_PM_SLEEP
Takashi Iwai68cb2b52012-07-02 15:20:37 +0200[diff] [blame]165extern const struct dev_pm_ops oxygen_pci_pm;
Clemens Ladisch4a4bc532008-05-13 09:24:39 +0200[diff] [blame]166#endif
Clemens Ladisch4c25b932010-09-07 13:37:10 +0200[diff] [blame]167void oxygen_pci_shutdown(struct pci_dev *pci);
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]168
169/* oxygen_mixer.c */
170
171int oxygen_mixer_init(struct oxygen *chip);
172void oxygen_update_dac_routing(struct oxygen *chip);
173void oxygen_update_spdif_source(struct oxygen *chip);
174
175/* oxygen_pcm.c */
176
177int oxygen_pcm_init(struct oxygen *chip);
178
179/* oxygen_io.c */
180
181u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
182u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
183u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
184void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
185void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
186void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
187void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
188 u8 value, u8 mask);
189void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
190 u16 value, u16 mask);
191void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
192 u32 value, u32 mask);
193
194u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
195 unsigned int index);
196void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
197 unsigned int index, u16 data);
198void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
199 unsigned int index, u16 data, u16 mask);
200
Roman Volkov303cff32014-01-24 16:18:03 +0400[diff] [blame]201int oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);
Clemens Ladisch10e6d5f2008-04-07 10:23:37 +0200[diff] [blame]202void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data);
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]203
Clemens Ladisch397b1dc2008-09-22 09:04:43 +0200[diff] [blame]204void oxygen_reset_uart(struct oxygen *chip);
205void oxygen_write_uart(struct oxygen *chip, u8 data);
206
Clemens Ladisch30459d72009-02-19 08:42:44 +0100[diff] [blame]207u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index);
Clemens Ladisch1275d6f2009-02-19 08:44:12 +0100[diff] [blame]208void oxygen_write_eeprom(struct oxygen *chip, unsigned int index, u16 value);
Clemens Ladisch30459d72009-02-19 08:42:44 +0100[diff] [blame]209
Clemens Ladischd0ce9942007-12-23 19:50:57 +0100[diff] [blame]210static inline void oxygen_set_bits8(struct oxygen *chip,
211 unsigned int reg, u8 value)
212{
213 oxygen_write8_masked(chip, reg, value, value);
214}
215
216static inline void oxygen_set_bits16(struct oxygen *chip,
217 unsigned int reg, u16 value)
218{
219 oxygen_write16_masked(chip, reg, value, value);
220}
221
222static inline void oxygen_set_bits32(struct oxygen *chip,
223 unsigned int reg, u32 value)
224{
225 oxygen_write32_masked(chip, reg, value, value);
226}
227
228static inline void oxygen_clear_bits8(struct oxygen *chip,
229 unsigned int reg, u8 value)
230{
231 oxygen_write8_masked(chip, reg, 0, value);
232}
233
234static inline void oxygen_clear_bits16(struct oxygen *chip,
235 unsigned int reg, u16 value)
236{
237 oxygen_write16_masked(chip, reg, 0, value);
238}
239
240static inline void oxygen_clear_bits32(struct oxygen *chip,
241 unsigned int reg, u32 value)
242{
243 oxygen_write32_masked(chip, reg, 0, value);
244}
245
246static inline void oxygen_ac97_set_bits(struct oxygen *chip, unsigned int codec,
247 unsigned int index, u16 value)
248{
249 oxygen_write_ac97_masked(chip, codec, index, value, value);
250}
251
252static inline void oxygen_ac97_clear_bits(struct oxygen *chip,
253 unsigned int codec,
254 unsigned int index, u16 value)
255{
256 oxygen_write_ac97_masked(chip, codec, index, 0, value);
257}
258
259#endif