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
  39 enum {
  40         CONTROL_SPDIF_PCM,
  41         CONTROL_SPDIF_INPUT_BITS,
  42         CONTROL_MIC_CAPTURE_SWITCH,
  43         CONTROL_LINE_CAPTURE_SWITCH,
  44         CONTROL_CD_CAPTURE_SWITCH,
  45         CONTROL_AUX_CAPTURE_SWITCH,
  46         CONTROL_COUNT
  47 };
  48
  49 #define OXYGEN_PCI_SUBID(sv, sd) \
  50         .vendor = PCI_VENDOR_ID_CMEDIA, \
  51         .device = 0x8788, \
  52         .subvendor = sv, \
  53         .subdevice = sd
  54
  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
  60 struct pci_dev;
  61 struct pci_device_id;
  62 struct snd_card;
  63 struct snd_pcm_substream;
  64 struct snd_pcm_hardware;
  65 struct snd_pcm_hw_params;
  66 struct snd_kcontrol_new;
  67 struct snd_rawmidi;
  68 struct oxygen;
  69
  70 struct oxygen_model {
  71         const char *shortname;
  72         const char *longname;
  73         const char *chip;
  74         void (*init)(struct oxygen *chip);
  75         int (*control_filter)(struct snd_kcontrol_new *template);
  76         int (*mixer_init)(struct oxygen *chip);
  77         void (*cleanup)(struct oxygen *chip);
  78         void (*suspend)(struct oxygen *chip);
  79         void (*resume)(struct oxygen *chip);
  80         void (*pcm_hardware_filter)(unsigned int channel,
  81                                     struct snd_pcm_hardware *hardware);
  82         unsigned int (*get_i2s_mclk)(struct oxygen *chip, unsigned int channel,
  83                                      struct snd_pcm_hw_params *hw_params);
  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);
  90         void (*update_center_lfe_mix)(struct oxygen *chip, bool mixed);
  91         void (*gpio_changed)(struct oxygen *chip);
  92         void (*uart_input)(struct oxygen *chip);
  93         void (*ac97_switch)(struct oxygen *chip,
  94                             unsigned int reg, unsigned int mute);
  95         const unsigned int *dac_tlv;
  96         unsigned long private_data;
  97         size_t model_data_size;
  98         unsigned int device_config;
  99         u8 dac_channels;
 100         u8 dac_volume_min;
 101         u8 dac_volume_max;
 102         u8 misc_flags;
 103         u8 function_flags;
 104         u16 dac_i2s_format;
 105         u16 adc_i2s_format;
 106 };
 107
 108 struct 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];
 140         unsigned int uart_input_count;
 141         u8 uart_input[32];
 142         struct oxygen_model model;
 143 };
 144
 145 /* oxygen_lib.c */
 146
 147 int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
 148                      struct module *owner,
 149                      const struct pci_device_id *ids,
 150                      int (*get_model)(struct oxygen *chip,
 151                                       const struct pci_device_id *id
 152                                      )
 153                     );
 154 void oxygen_pci_remove(struct pci_dev *pci);
 155 #ifdef CONFIG_PM
 156 int oxygen_pci_suspend(struct pci_dev *pci, pm_message_t state);
 157 int oxygen_pci_resume(struct pci_dev *pci);
 158 #endif
 159 void oxygen_pci_shutdown(struct pci_dev *pci);
 160
 161 /* oxygen_mixer.c */
 162
 163 int oxygen_mixer_init(struct oxygen *chip);
 164 void oxygen_update_dac_routing(struct oxygen *chip);
 165 void oxygen_update_spdif_source(struct oxygen *chip);
 166
 167 /* oxygen_pcm.c */
 168
 169 int oxygen_pcm_init(struct oxygen *chip);
 170 unsigned int oxygen_default_i2s_mclk(struct oxygen *chip, unsigned int channel,
 171                                      struct snd_pcm_hw_params *hw_params);
 172
 173 /* oxygen_io.c */
 174
 175 u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
 176 u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
 177 u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
 178 void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
 179 void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
 180 void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
 181 void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
 182                           u8 value, u8 mask);
 183 void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
 184                            u16 value, u16 mask);
 185 void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
 186                            u32 value, u32 mask);
 187
 188 u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
 189                      unsigned int index);
 190 void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
 191                        unsigned int index, u16 data);
 192 void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
 193                               unsigned int index, u16 data, u16 mask);
 194
 195 void oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);
 196 void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data);
 197
 198 void oxygen_reset_uart(struct oxygen *chip);
 199 void oxygen_write_uart(struct oxygen *chip, u8 data);
 200
 201 u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index);
 202 void oxygen_write_eeprom(struct oxygen *chip, unsigned int index, u16 value);
 203
 204 static 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
 210 static 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
 216 static 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
 222 static 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
 228 static 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
 234 static 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
 240 static 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
 246 static 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