sound/pci/oxygen/oxygen.h

   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_MCLKS(f_single, f_double, f_quad) ((MCLK_##f_single << 0) | \
  20                                                   (MCLK_##f_double << 2) | \
  21                                                   (MCLK_##f_quad   << 4))
  22
  23 #define OXYGEN_IO_SIZE  0x100
  24
  25 #define OXYGEN_EEPROM_ID        0x434d  /* "CM" */
  26
  27 /* model-specific configuration of outputs/inputs */
  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
  41 #define AC97_CD_INPUT           0x2000
  42 #define AC97_FMIC_SWITCH        0x4000
  43
  44 enum {
  45         CONTROL_SPDIF_PCM,
  46         CONTROL_SPDIF_INPUT_BITS,
  47         CONTROL_MIC_CAPTURE_SWITCH,
  48         CONTROL_LINE_CAPTURE_SWITCH,
  49         CONTROL_CD_CAPTURE_SWITCH,
  50         CONTROL_AUX_CAPTURE_SWITCH,
  51         CONTROL_COUNT
  52 };
  53
  54 #define OXYGEN_PCI_SUBID(sv, sd) \
  55         .vendor = PCI_VENDOR_ID_CMEDIA, \
  56         .device = 0x8788, \
  57         .subvendor = sv, \
  58         .subdevice = sd
  59
  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
  65 struct pci_dev;
  66 struct pci_device_id;
  67 struct snd_card;
  68 struct snd_pcm_substream;
  69 struct snd_pcm_hardware;
  70 struct snd_pcm_hw_params;
  71 struct snd_kcontrol_new;
  72 struct snd_rawmidi;
  73 struct snd_info_buffer;
  74 struct oxygen;
  75
  76 struct oxygen_model {
  77         const char *shortname;
  78         const char *longname;
  79         const char *chip;
  80         void (*init)(struct oxygen *chip);
  81         int (*control_filter)(struct snd_kcontrol_new *template);
  82         int (*mixer_init)(struct oxygen *chip);
  83         void (*cleanup)(struct oxygen *chip);
  84         void (*suspend)(struct oxygen *chip);
  85         void (*resume)(struct oxygen *chip);
  86         void (*pcm_hardware_filter)(unsigned int channel,
  87                                     struct snd_pcm_hardware *hardware);
  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);
  94         void (*update_center_lfe_mix)(struct oxygen *chip, bool mixed);
  95         void (*gpio_changed)(struct oxygen *chip);
  96         void (*uart_input)(struct oxygen *chip);
  97         void (*ac97_switch)(struct oxygen *chip,
  98                             unsigned int reg, unsigned int mute);
  99         void (*dump_registers)(struct oxygen *chip,
 100                                struct snd_info_buffer *buffer);
 101         const unsigned int *dac_tlv;
 102         size_t model_data_size;
 103         unsigned int device_config;
 104         u8 dac_channels_pcm;
 105         u8 dac_channels_mixer;
 106         u8 dac_volume_min;
 107         u8 dac_volume_max;
 108         u8 misc_flags;
 109         u8 function_flags;
 110         u8 dac_mclks;
 111         u8 adc_mclks;
 112         u16 dac_i2s_format;
 113         u16 adc_i2s_format;
 114 };
 115
 116 struct 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;
 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];
 147         unsigned int uart_input_count;
 148         u8 uart_input[32];
 149         struct oxygen_model model;
 150 };
 151
 152 /* oxygen_lib.c */
 153
 154 int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
 155                      struct module *owner,
 156                      const struct pci_device_id *ids,
 157                      int (*get_model)(struct oxygen *chip,
 158                                       const struct pci_device_id *id
 159                                      )
 160                     );
 161 void oxygen_pci_remove(struct pci_dev *pci);
 162 #ifdef CONFIG_PM
 163 int oxygen_pci_suspend(struct pci_dev *pci, pm_message_t state);
 164 int oxygen_pci_resume(struct pci_dev *pci);
 165 #endif
 166 void oxygen_pci_shutdown(struct pci_dev *pci);
 167
 168 /* oxygen_mixer.c */
 169
 170 int oxygen_mixer_init(struct oxygen *chip);
 171 void oxygen_update_dac_routing(struct oxygen *chip);
 172 void oxygen_update_spdif_source(struct oxygen *chip);
 173
 174 /* oxygen_pcm.c */
 175
 176 int oxygen_pcm_init(struct oxygen *chip);
 177
 178 /* oxygen_io.c */
 179
 180 u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
 181 u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
 182 u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
 183 void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
 184 void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
 185 void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
 186 void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
 187                           u8 value, u8 mask);
 188 void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
 189                            u16 value, u16 mask);
 190 void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
 191                            u32 value, u32 mask);
 192
 193 u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
 194                      unsigned int index);
 195 void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
 196                        unsigned int index, u16 data);
 197 void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
 198                               unsigned int index, u16 data, u16 mask);
 199
 200 void oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);
 201 void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data);
 202
 203 void oxygen_reset_uart(struct oxygen *chip);
 204 void oxygen_write_uart(struct oxygen *chip, u8 data);
 205
 206 u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index);
 207 void oxygen_write_eeprom(struct oxygen *chip, unsigned int index, u16 value);
 208
 209 static 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
 215 static 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
 221 static 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
 227 static 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
 233 static 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
 239 static 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
 245 static 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
 251 static 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