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