oxygen.h 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef OXYGEN_H_INCLUDED
  3. #define OXYGEN_H_INCLUDED
  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. /* 1 << PCM_x == OXYGEN_CHANNEL_x */
  10. #define PCM_A 0
  11. #define PCM_B 1
  12. #define PCM_C 2
  13. #define PCM_SPDIF 3
  14. #define PCM_MULTICH 4
  15. #define PCM_AC97 5
  16. #define PCM_COUNT 6
  17. #define OXYGEN_MCLKS(f_single, f_double, f_quad) ((MCLK_##f_single << 0) | \
  18. (MCLK_##f_double << 2) | \
  19. (MCLK_##f_quad << 4))
  20. #define OXYGEN_IO_SIZE 0x100
  21. #define OXYGEN_EEPROM_ID 0x434d /* "CM" */
  22. /* model-specific configuration of outputs/inputs */
  23. #define PLAYBACK_0_TO_I2S 0x0001
  24. /* PLAYBACK_0_TO_AC97_0 not implemented */
  25. #define PLAYBACK_1_TO_SPDIF 0x0004
  26. #define PLAYBACK_2_TO_AC97_1 0x0008
  27. #define CAPTURE_0_FROM_I2S_1 0x0010
  28. #define CAPTURE_0_FROM_I2S_2 0x0020
  29. /* CAPTURE_0_FROM_AC97_0 not implemented */
  30. #define CAPTURE_1_FROM_SPDIF 0x0080
  31. #define CAPTURE_2_FROM_I2S_2 0x0100
  32. #define CAPTURE_2_FROM_AC97_1 0x0200
  33. #define CAPTURE_3_FROM_I2S_3 0x0400
  34. #define MIDI_OUTPUT 0x0800
  35. #define MIDI_INPUT 0x1000
  36. #define AC97_CD_INPUT 0x2000
  37. #define AC97_FMIC_SWITCH 0x4000
  38. enum {
  39. CONTROL_SPDIF_PCM,
  40. CONTROL_SPDIF_INPUT_BITS,
  41. CONTROL_MIC_CAPTURE_SWITCH,
  42. CONTROL_LINE_CAPTURE_SWITCH,
  43. CONTROL_CD_CAPTURE_SWITCH,
  44. CONTROL_AUX_CAPTURE_SWITCH,
  45. CONTROL_COUNT
  46. };
  47. #define OXYGEN_PCI_SUBID(sv, sd) \
  48. .vendor = PCI_VENDOR_ID_CMEDIA, \
  49. .device = 0x8788, \
  50. .subvendor = sv, \
  51. .subdevice = sd
  52. #define BROKEN_EEPROM_DRIVER_DATA ((unsigned long)-1)
  53. #define OXYGEN_PCI_SUBID_BROKEN_EEPROM \
  54. OXYGEN_PCI_SUBID(PCI_VENDOR_ID_CMEDIA, 0x8788), \
  55. .driver_data = BROKEN_EEPROM_DRIVER_DATA
  56. struct pci_dev;
  57. struct pci_device_id;
  58. struct snd_card;
  59. struct snd_pcm_substream;
  60. struct snd_pcm_hardware;
  61. struct snd_pcm_hw_params;
  62. struct snd_kcontrol_new;
  63. struct snd_rawmidi;
  64. struct snd_info_buffer;
  65. struct oxygen;
  66. struct oxygen_model {
  67. const char *shortname;
  68. const char *longname;
  69. const char *chip;
  70. void (*init)(struct oxygen *chip);
  71. int (*control_filter)(struct snd_kcontrol_new *template);
  72. int (*mixer_init)(struct oxygen *chip);
  73. void (*cleanup)(struct oxygen *chip);
  74. void (*suspend)(struct oxygen *chip);
  75. void (*resume)(struct oxygen *chip);
  76. void (*pcm_hardware_filter)(unsigned int channel,
  77. struct snd_pcm_hardware *hardware);
  78. void (*set_dac_params)(struct oxygen *chip,
  79. struct snd_pcm_hw_params *params);
  80. void (*set_adc_params)(struct oxygen *chip,
  81. struct snd_pcm_hw_params *params);
  82. void (*update_dac_volume)(struct oxygen *chip);
  83. void (*update_dac_mute)(struct oxygen *chip);
  84. void (*update_center_lfe_mix)(struct oxygen *chip, bool mixed);
  85. unsigned int (*adjust_dac_routing)(struct oxygen *chip,
  86. unsigned int play_routing);
  87. void (*gpio_changed)(struct oxygen *chip);
  88. void (*uart_input)(struct oxygen *chip);
  89. void (*ac97_switch)(struct oxygen *chip,
  90. unsigned int reg, unsigned int mute);
  91. void (*dump_registers)(struct oxygen *chip,
  92. struct snd_info_buffer *buffer);
  93. const unsigned int *dac_tlv;
  94. size_t model_data_size;
  95. unsigned int device_config;
  96. u8 dac_channels_pcm;
  97. u8 dac_channels_mixer;
  98. u8 dac_volume_min;
  99. u8 dac_volume_max;
  100. u8 misc_flags;
  101. u8 function_flags;
  102. u8 dac_mclks;
  103. u8 adc_mclks;
  104. u16 dac_i2s_format;
  105. u16 adc_i2s_format;
  106. };
  107. struct oxygen {
  108. unsigned long addr;
  109. spinlock_t reg_lock;
  110. struct mutex mutex;
  111. struct snd_card *card;
  112. struct pci_dev *pci;
  113. struct snd_rawmidi *midi;
  114. int irq;
  115. void *model_data;
  116. unsigned int interrupt_mask;
  117. u8 dac_volume[8];
  118. u8 dac_mute;
  119. u8 pcm_active;
  120. u8 pcm_running;
  121. u8 dac_routing;
  122. u8 spdif_playback_enable;
  123. u8 has_ac97_0;
  124. u8 has_ac97_1;
  125. u32 spdif_bits;
  126. u32 spdif_pcm_bits;
  127. struct snd_pcm_substream *streams[PCM_COUNT];
  128. struct snd_kcontrol *controls[CONTROL_COUNT];
  129. struct work_struct spdif_input_bits_work;
  130. struct work_struct gpio_work;
  131. wait_queue_head_t ac97_waitqueue;
  132. union {
  133. u8 _8[OXYGEN_IO_SIZE];
  134. __le16 _16[OXYGEN_IO_SIZE / 2];
  135. __le32 _32[OXYGEN_IO_SIZE / 4];
  136. } saved_registers;
  137. u16 saved_ac97_registers[2][0x40];
  138. unsigned int uart_input_count;
  139. u8 uart_input[32];
  140. struct oxygen_model model;
  141. };
  142. /* oxygen_lib.c */
  143. int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
  144. struct module *owner,
  145. const struct pci_device_id *ids,
  146. int (*get_model)(struct oxygen *chip,
  147. const struct pci_device_id *id
  148. )
  149. );
  150. #ifdef CONFIG_PM_SLEEP
  151. extern const struct dev_pm_ops oxygen_pci_pm;
  152. #endif
  153. void oxygen_pci_shutdown(struct pci_dev *pci);
  154. /* oxygen_mixer.c */
  155. int oxygen_mixer_init(struct oxygen *chip);
  156. void oxygen_update_dac_routing(struct oxygen *chip);
  157. void oxygen_update_spdif_source(struct oxygen *chip);
  158. /* oxygen_pcm.c */
  159. int oxygen_pcm_init(struct oxygen *chip);
  160. /* oxygen_io.c */
  161. u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
  162. u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
  163. u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
  164. void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
  165. void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
  166. void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
  167. void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
  168. u8 value, u8 mask);
  169. void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
  170. u16 value, u16 mask);
  171. void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
  172. u32 value, u32 mask);
  173. u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
  174. unsigned int index);
  175. void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
  176. unsigned int index, u16 data);
  177. void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
  178. unsigned int index, u16 data, u16 mask);
  179. int oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);
  180. void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data);
  181. void oxygen_reset_uart(struct oxygen *chip);
  182. void oxygen_write_uart(struct oxygen *chip, u8 data);
  183. u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index);
  184. void oxygen_write_eeprom(struct oxygen *chip, unsigned int index, u16 value);
  185. static inline void oxygen_set_bits8(struct oxygen *chip,
  186. unsigned int reg, u8 value)
  187. {
  188. oxygen_write8_masked(chip, reg, value, value);
  189. }
  190. static inline void oxygen_set_bits16(struct oxygen *chip,
  191. unsigned int reg, u16 value)
  192. {
  193. oxygen_write16_masked(chip, reg, value, value);
  194. }
  195. static inline void oxygen_set_bits32(struct oxygen *chip,
  196. unsigned int reg, u32 value)
  197. {
  198. oxygen_write32_masked(chip, reg, value, value);
  199. }
  200. static inline void oxygen_clear_bits8(struct oxygen *chip,
  201. unsigned int reg, u8 value)
  202. {
  203. oxygen_write8_masked(chip, reg, 0, value);
  204. }
  205. static inline void oxygen_clear_bits16(struct oxygen *chip,
  206. unsigned int reg, u16 value)
  207. {
  208. oxygen_write16_masked(chip, reg, 0, value);
  209. }
  210. static inline void oxygen_clear_bits32(struct oxygen *chip,
  211. unsigned int reg, u32 value)
  212. {
  213. oxygen_write32_masked(chip, reg, 0, value);
  214. }
  215. static inline void oxygen_ac97_set_bits(struct oxygen *chip, unsigned int codec,
  216. unsigned int index, u16 value)
  217. {
  218. oxygen_write_ac97_masked(chip, codec, index, value, value);
  219. }
  220. static inline void oxygen_ac97_clear_bits(struct oxygen *chip,
  221. unsigned int codec,
  222. unsigned int index, u16 value)
  223. {
  224. oxygen_write_ac97_masked(chip, codec, index, 0, value);
  225. }
  226. #endif