Thomas Gleixner | c942fdd | 2019-05-27 08:55:06 +0200 | [diff] [blame^] | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
Dylan Reid | 05e8487 | 2014-02-28 15:41:22 -0800 | [diff] [blame] | 2 | /* |
| 3 | * Common functionality for the alsa driver code base for HD Audio. |
Dylan Reid | 05e8487 | 2014-02-28 15:41:22 -0800 | [diff] [blame] | 4 | */ |
| 5 | |
| 6 | #ifndef __SOUND_HDA_CONTROLLER_H |
| 7 | #define __SOUND_HDA_CONTROLLER_H |
| 8 | |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 9 | #include <linux/timecounter.h> |
| 10 | #include <linux/interrupt.h> |
Dylan Reid | 05e8487 | 2014-02-28 15:41:22 -0800 | [diff] [blame] | 11 | #include <sound/core.h> |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 12 | #include <sound/pcm.h> |
Dylan Reid | 05e8487 | 2014-02-28 15:41:22 -0800 | [diff] [blame] | 13 | #include <sound/initval.h> |
Pierre-Louis Bossart | be57bff | 2018-08-22 15:24:57 -0500 | [diff] [blame] | 14 | #include <sound/hda_codec.h> |
Takashi Iwai | 1475241 | 2015-04-14 12:15:47 +0200 | [diff] [blame] | 15 | #include <sound/hda_register.h> |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 16 | |
Takashi Iwai | 1475241 | 2015-04-14 12:15:47 +0200 | [diff] [blame] | 17 | #define AZX_MAX_CODECS HDA_MAX_CODECS |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 18 | #define AZX_DEFAULT_CODECS 4 |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 19 | |
| 20 | /* driver quirks (capabilities) */ |
| 21 | /* bits 0-7 are used for indicating driver type */ |
| 22 | #define AZX_DCAPS_NO_TCSEL (1 << 8) /* No Intel TCSEL bit */ |
| 23 | #define AZX_DCAPS_NO_MSI (1 << 9) /* No MSI support */ |
| 24 | #define AZX_DCAPS_SNOOP_MASK (3 << 10) /* snoop type mask */ |
| 25 | #define AZX_DCAPS_SNOOP_OFF (1 << 12) /* snoop default off */ |
Takashi Iwai | dba9b7b | 2017-06-29 16:18:12 +0200 | [diff] [blame] | 26 | #ifdef CONFIG_SND_HDA_I915 |
| 27 | #define AZX_DCAPS_I915_COMPONENT (1 << 13) /* bind with i915 gfx */ |
| 28 | #else |
| 29 | #define AZX_DCAPS_I915_COMPONENT 0 /* NOP */ |
| 30 | #endif |
Takashi Iwai | 3e9ad24 | 2018-12-31 19:02:01 +0100 | [diff] [blame] | 31 | /* 14 unused */ |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 32 | #define AZX_DCAPS_CTX_WORKAROUND (1 << 15) /* X-Fi workaround */ |
| 33 | #define AZX_DCAPS_POSFIX_LPIB (1 << 16) /* Use LPIB as default */ |
Takashi Iwai | 26f0571 | 2015-12-17 08:29:53 +0100 | [diff] [blame] | 34 | /* 17 unused */ |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 35 | #define AZX_DCAPS_NO_64BIT (1 << 18) /* No 64bit address */ |
| 36 | #define AZX_DCAPS_SYNC_WRITE (1 << 19) /* sync each cmd write */ |
| 37 | #define AZX_DCAPS_OLD_SSYNC (1 << 20) /* Old SSYNC reg for ICH */ |
| 38 | #define AZX_DCAPS_NO_ALIGN_BUFSIZE (1 << 21) /* no buffer size alignment */ |
| 39 | /* 22 unused */ |
| 40 | #define AZX_DCAPS_4K_BDLE_BOUNDARY (1 << 23) /* BDLE in 4k boundary */ |
Takashi Iwai | bcb337d | 2015-12-17 08:31:45 +0100 | [diff] [blame] | 41 | /* 24 unused */ |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 42 | #define AZX_DCAPS_COUNT_LPIB_DELAY (1 << 25) /* Take LPIB as delay */ |
| 43 | #define AZX_DCAPS_PM_RUNTIME (1 << 26) /* runtime PM support */ |
Takashi Iwai | e454ff8 | 2018-12-09 09:57:37 +0100 | [diff] [blame] | 44 | /* 27 unused */ |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 45 | #define AZX_DCAPS_CORBRP_SELF_CLEAR (1 << 28) /* CORBRP clears itself after reset */ |
| 46 | #define AZX_DCAPS_NO_MSI64 (1 << 29) /* Stick to 32-bit MSIs */ |
| 47 | #define AZX_DCAPS_SEPARATE_STREAM_TAG (1 << 30) /* capture and playback use separate stream tag */ |
| 48 | |
| 49 | enum { |
| 50 | AZX_SNOOP_TYPE_NONE, |
| 51 | AZX_SNOOP_TYPE_SCH, |
| 52 | AZX_SNOOP_TYPE_ATI, |
| 53 | AZX_SNOOP_TYPE_NVIDIA, |
| 54 | }; |
| 55 | |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 56 | struct azx_dev { |
Takashi Iwai | 7833c3f | 2015-04-14 18:13:13 +0200 | [diff] [blame] | 57 | struct hdac_stream core; |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 58 | |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 59 | unsigned int irq_pending:1; |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 60 | /* |
| 61 | * For VIA: |
| 62 | * A flag to ensure DMA position is 0 |
| 63 | * when link position is not greater than FIFO size |
| 64 | */ |
| 65 | unsigned int insufficient:1; |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 66 | }; |
| 67 | |
Takashi Iwai | 7833c3f | 2015-04-14 18:13:13 +0200 | [diff] [blame] | 68 | #define azx_stream(dev) (&(dev)->core) |
| 69 | #define stream_to_azx_dev(s) container_of(s, struct azx_dev, core) |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 70 | |
| 71 | struct azx; |
| 72 | |
| 73 | /* Functions to read/write to hda registers. */ |
| 74 | struct hda_controller_ops { |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 75 | /* Disable msi if supported, PCI only */ |
| 76 | int (*disable_msi_reset_irq)(struct azx *); |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 77 | void (*pcm_mmap_prepare)(struct snd_pcm_substream *substream, |
| 78 | struct vm_area_struct *area); |
| 79 | /* Check if current position is acceptable */ |
| 80 | int (*position_check)(struct azx *chip, struct azx_dev *azx_dev); |
Mengdong Lin | 17eccb2 | 2015-04-29 17:43:29 +0800 | [diff] [blame] | 81 | /* enable/disable the link power */ |
| 82 | int (*link_power)(struct azx *chip, bool enable); |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 83 | }; |
| 84 | |
| 85 | struct azx_pcm { |
| 86 | struct azx *chip; |
| 87 | struct snd_pcm *pcm; |
| 88 | struct hda_codec *codec; |
Takashi Iwai | 820cc6c | 2015-02-20 12:50:46 +0100 | [diff] [blame] | 89 | struct hda_pcm *info; |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 90 | struct list_head list; |
| 91 | }; |
| 92 | |
| 93 | typedef unsigned int (*azx_get_pos_callback_t)(struct azx *, struct azx_dev *); |
| 94 | typedef int (*azx_get_delay_callback_t)(struct azx *, struct azx_dev *, unsigned int pos); |
| 95 | |
| 96 | struct azx { |
Takashi Iwai | a41d122 | 2015-04-14 22:13:18 +0200 | [diff] [blame] | 97 | struct hda_bus bus; |
| 98 | |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 99 | struct snd_card *card; |
| 100 | struct pci_dev *pci; |
| 101 | int dev_index; |
| 102 | |
| 103 | /* chip type specific */ |
| 104 | int driver_type; |
| 105 | unsigned int driver_caps; |
| 106 | int playback_streams; |
| 107 | int playback_index_offset; |
| 108 | int capture_streams; |
| 109 | int capture_index_offset; |
| 110 | int num_streams; |
Takashi Iwai | 3a182c8 | 2018-08-30 07:58:50 +0200 | [diff] [blame] | 111 | int jackpoll_interval; /* jack poll interval in jiffies */ |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 112 | |
| 113 | /* Register interaction. */ |
| 114 | const struct hda_controller_ops *ops; |
| 115 | |
| 116 | /* position adjustment callbacks */ |
| 117 | azx_get_pos_callback_t get_position[2]; |
| 118 | azx_get_delay_callback_t get_delay[2]; |
| 119 | |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 120 | /* locks */ |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 121 | struct mutex open_mutex; /* Prevents concurrent open/close operations */ |
| 122 | |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 123 | /* PCM */ |
| 124 | struct list_head pcm_list; /* azx_pcm list */ |
| 125 | |
| 126 | /* HD codec */ |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 127 | int codec_probe_mask; /* copied from probe_mask option */ |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 128 | unsigned int beep_mode; |
| 129 | |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 130 | #ifdef CONFIG_SND_HDA_PATCH_LOADER |
| 131 | const struct firmware *fw; |
| 132 | #endif |
| 133 | |
| 134 | /* flags */ |
Takashi Iwai | 4f0189b | 2015-12-10 16:44:08 +0100 | [diff] [blame] | 135 | int bdl_pos_adj; |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 136 | int poll_count; |
| 137 | unsigned int running:1; |
Takashi Iwai | 41438f1 | 2017-01-12 17:13:21 +0100 | [diff] [blame] | 138 | unsigned int fallback_to_single_cmd:1; |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 139 | unsigned int single_cmd:1; |
| 140 | unsigned int polling_mode:1; |
| 141 | unsigned int msi:1; |
| 142 | unsigned int probing:1; /* codec probing phase */ |
| 143 | unsigned int snoop:1; |
Takashi Iwai | 78c9be6 | 2018-08-11 23:33:34 +0200 | [diff] [blame] | 144 | unsigned int uc_buffer:1; /* non-cached pages for stream buffers */ |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 145 | unsigned int align_buffer_size:1; |
| 146 | unsigned int region_requested:1; |
Lukas Wunner | 2b760d8 | 2015-09-04 20:49:36 +0200 | [diff] [blame] | 147 | unsigned int disabled:1; /* disabled by vga_switcheroo */ |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 148 | |
Guneshwor Singh | 50279d9 | 2016-08-04 15:46:03 +0530 | [diff] [blame] | 149 | /* GTS present */ |
| 150 | unsigned int gts_present:1; |
| 151 | |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 152 | #ifdef CONFIG_SND_HDA_DSP_LOADER |
| 153 | struct azx_dev saved_azx_dev; |
| 154 | #endif |
| 155 | }; |
| 156 | |
Takashi Iwai | a41d122 | 2015-04-14 22:13:18 +0200 | [diff] [blame] | 157 | #define azx_bus(chip) (&(chip)->bus.core) |
| 158 | #define bus_to_azx(_bus) container_of(_bus, struct azx, bus.core) |
Takashi Iwai | a43ff5b | 2015-04-14 17:26:00 +0200 | [diff] [blame] | 159 | |
Anders Roxell | 5b03006d | 2018-09-11 16:18:36 +0200 | [diff] [blame] | 160 | static inline bool azx_snoop(struct azx *chip) |
| 161 | { |
| 162 | return !IS_ENABLED(CONFIG_X86) || chip->snoop; |
| 163 | } |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 164 | |
| 165 | /* |
| 166 | * macros for easy use |
| 167 | */ |
| 168 | |
| 169 | #define azx_writel(chip, reg, value) \ |
Takashi Iwai | a41d122 | 2015-04-14 22:13:18 +0200 | [diff] [blame] | 170 | snd_hdac_chip_writel(azx_bus(chip), reg, value) |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 171 | #define azx_readl(chip, reg) \ |
Takashi Iwai | a41d122 | 2015-04-14 22:13:18 +0200 | [diff] [blame] | 172 | snd_hdac_chip_readl(azx_bus(chip), reg) |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 173 | #define azx_writew(chip, reg, value) \ |
Takashi Iwai | a41d122 | 2015-04-14 22:13:18 +0200 | [diff] [blame] | 174 | snd_hdac_chip_writew(azx_bus(chip), reg, value) |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 175 | #define azx_readw(chip, reg) \ |
Takashi Iwai | a41d122 | 2015-04-14 22:13:18 +0200 | [diff] [blame] | 176 | snd_hdac_chip_readw(azx_bus(chip), reg) |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 177 | #define azx_writeb(chip, reg, value) \ |
Takashi Iwai | a41d122 | 2015-04-14 22:13:18 +0200 | [diff] [blame] | 178 | snd_hdac_chip_writeb(azx_bus(chip), reg, value) |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 179 | #define azx_readb(chip, reg) \ |
Takashi Iwai | a41d122 | 2015-04-14 22:13:18 +0200 | [diff] [blame] | 180 | snd_hdac_chip_readb(azx_bus(chip), reg) |
Takashi Iwai | 89a93fe | 2015-02-19 18:04:17 +0100 | [diff] [blame] | 181 | |
| 182 | #define azx_has_pm_runtime(chip) \ |
David Henningsson | 828fa8c | 2015-04-15 13:29:05 +0200 | [diff] [blame] | 183 | ((chip)->driver_caps & AZX_DCAPS_PM_RUNTIME) |
Dylan Reid | 05e8487 | 2014-02-28 15:41:22 -0800 | [diff] [blame] | 184 | |
| 185 | /* PCM setup */ |
Dylan Reid | 05e8487 | 2014-02-28 15:41:22 -0800 | [diff] [blame] | 186 | static inline struct azx_dev *get_azx_dev(struct snd_pcm_substream *substream) |
| 187 | { |
| 188 | return substream->runtime->private_data; |
| 189 | } |
Takashi Iwai | b6050ef | 2014-06-26 16:50:16 +0200 | [diff] [blame] | 190 | unsigned int azx_get_position(struct azx *chip, struct azx_dev *azx_dev); |
| 191 | unsigned int azx_get_pos_lpib(struct azx *chip, struct azx_dev *azx_dev); |
| 192 | unsigned int azx_get_pos_posbuf(struct azx *chip, struct azx_dev *azx_dev); |
Dylan Reid | 05e8487 | 2014-02-28 15:41:22 -0800 | [diff] [blame] | 193 | |
| 194 | /* Stream control. */ |
Takashi Iwai | 7833c3f | 2015-04-14 18:13:13 +0200 | [diff] [blame] | 195 | void azx_stop_all_streams(struct azx *chip); |
Dylan Reid | 05e8487 | 2014-02-28 15:41:22 -0800 | [diff] [blame] | 196 | |
Dylan Reid | 6790899 | 2014-02-28 15:41:23 -0800 | [diff] [blame] | 197 | /* Allocation functions. */ |
Takashi Iwai | a41d122 | 2015-04-14 22:13:18 +0200 | [diff] [blame] | 198 | #define azx_alloc_stream_pages(chip) \ |
| 199 | snd_hdac_bus_alloc_stream_pages(azx_bus(chip)) |
| 200 | #define azx_free_stream_pages(chip) \ |
| 201 | snd_hdac_bus_free_stream_pages(azx_bus(chip)) |
Dylan Reid | 6790899 | 2014-02-28 15:41:23 -0800 | [diff] [blame] | 202 | |
Dylan Reid | f43923f | 2014-02-28 15:41:27 -0800 | [diff] [blame] | 203 | /* Low level azx interface */ |
Thierry Reding | 17c3ad0 | 2014-04-09 12:30:57 +0200 | [diff] [blame] | 204 | void azx_init_chip(struct azx *chip, bool full_reset); |
Dylan Reid | f43923f | 2014-02-28 15:41:27 -0800 | [diff] [blame] | 205 | void azx_stop_chip(struct azx *chip); |
Takashi Iwai | a41d122 | 2015-04-14 22:13:18 +0200 | [diff] [blame] | 206 | #define azx_enter_link_reset(chip) \ |
| 207 | snd_hdac_bus_enter_link_reset(azx_bus(chip)) |
Dylan Reid | f0b1df8 | 2014-02-28 15:41:29 -0800 | [diff] [blame] | 208 | irqreturn_t azx_interrupt(int irq, void *dev_id); |
Dylan Reid | f43923f | 2014-02-28 15:41:27 -0800 | [diff] [blame] | 209 | |
Dylan Reid | 154867c | 2014-02-28 15:41:30 -0800 | [diff] [blame] | 210 | /* Codec interface */ |
Takashi Iwai | a41d122 | 2015-04-14 22:13:18 +0200 | [diff] [blame] | 211 | int azx_bus_init(struct azx *chip, const char *model, |
| 212 | const struct hdac_io_ops *io_ops); |
Takashi Iwai | 96d2bd6 | 2015-02-19 18:12:22 +0100 | [diff] [blame] | 213 | int azx_probe_codecs(struct azx *chip, unsigned int max_slots); |
Dylan Reid | 154867c | 2014-02-28 15:41:30 -0800 | [diff] [blame] | 214 | int azx_codec_configure(struct azx *chip); |
Takashi Iwai | a41d122 | 2015-04-14 22:13:18 +0200 | [diff] [blame] | 215 | int azx_init_streams(struct azx *chip); |
| 216 | void azx_free_streams(struct azx *chip); |
Dylan Reid | 154867c | 2014-02-28 15:41:30 -0800 | [diff] [blame] | 217 | |
Dylan Reid | 05e8487 | 2014-02-28 15:41:22 -0800 | [diff] [blame] | 218 | #endif /* __SOUND_HDA_CONTROLLER_H */ |