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