2 * Common functionality for the alsa driver code base for HD Audio.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; either version 2 of the License, or (at your option)
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 #ifndef __SOUND_HDA_CONTROLLER_H
16 #define __SOUND_HDA_CONTROLLER_H
18 #include <linux/timecounter.h>
19 #include <linux/interrupt.h>
20 #include <sound/core.h>
21 #include <sound/pcm.h>
22 #include <sound/initval.h>
23 #include "hda_codec.h"
24 #include <sound/hda_register.h>
26 #define AZX_MAX_CODECS HDA_MAX_CODECS
27 #define AZX_DEFAULT_CODECS 4
29 /* driver quirks (capabilities) */
30 /* bits 0-7 are used for indicating driver type */
31 #define AZX_DCAPS_NO_TCSEL (1 << 8) /* No Intel TCSEL bit */
32 #define AZX_DCAPS_NO_MSI (1 << 9) /* No MSI support */
33 #define AZX_DCAPS_SNOOP_MASK (3 << 10) /* snoop type mask */
34 #define AZX_DCAPS_SNOOP_OFF (1 << 12) /* snoop default off */
35 #ifdef CONFIG_SND_HDA_I915
36 #define AZX_DCAPS_I915_COMPONENT (1 << 13) /* bind with i915 gfx */
38 #define AZX_DCAPS_I915_COMPONENT 0 /* NOP */
41 #define AZX_DCAPS_CTX_WORKAROUND (1 << 15) /* X-Fi workaround */
42 #define AZX_DCAPS_POSFIX_LPIB (1 << 16) /* Use LPIB as default */
43 #define AZX_DCAPS_AMD_WORKAROUND (1 << 17) /* AMD-specific workaround */
44 #define AZX_DCAPS_NO_64BIT (1 << 18) /* No 64bit address */
45 #define AZX_DCAPS_SYNC_WRITE (1 << 19) /* sync each cmd write */
46 #define AZX_DCAPS_OLD_SSYNC (1 << 20) /* Old SSYNC reg for ICH */
47 #define AZX_DCAPS_NO_ALIGN_BUFSIZE (1 << 21) /* no buffer size alignment */
49 #define AZX_DCAPS_4K_BDLE_BOUNDARY (1 << 23) /* BDLE in 4k boundary */
51 #define AZX_DCAPS_COUNT_LPIB_DELAY (1 << 25) /* Take LPIB as delay */
52 #define AZX_DCAPS_PM_RUNTIME (1 << 26) /* runtime PM support */
53 #ifdef CONFIG_SND_HDA_I915
54 #define AZX_DCAPS_I915_POWERWELL (1 << 27) /* HSW i915 powerwell support */
56 #define AZX_DCAPS_I915_POWERWELL 0 /* NOP */
58 #define AZX_DCAPS_CORBRP_SELF_CLEAR (1 << 28) /* CORBRP clears itself after reset */
59 #define AZX_DCAPS_NO_MSI64 (1 << 29) /* Stick to 32-bit MSIs */
60 #define AZX_DCAPS_SEPARATE_STREAM_TAG (1 << 30) /* capture and playback use separate stream tag */
66 AZX_SNOOP_TYPE_NVIDIA
,
70 struct hdac_stream core
;
72 unsigned int irq_pending
:1;
75 * A flag to ensure DMA position is 0
76 * when link position is not greater than FIFO size
78 unsigned int insufficient
:1;
79 unsigned int wc_marked
:1;
82 #define azx_stream(dev) (&(dev)->core)
83 #define stream_to_azx_dev(s) container_of(s, struct azx_dev, core)
87 /* Functions to read/write to hda registers. */
88 struct hda_controller_ops
{
89 /* Disable msi if supported, PCI only */
90 int (*disable_msi_reset_irq
)(struct azx
*);
91 int (*substream_alloc_pages
)(struct azx
*chip
,
92 struct snd_pcm_substream
*substream
,
94 int (*substream_free_pages
)(struct azx
*chip
,
95 struct snd_pcm_substream
*substream
);
96 void (*pcm_mmap_prepare
)(struct snd_pcm_substream
*substream
,
97 struct vm_area_struct
*area
);
98 /* Check if current position is acceptable */
99 int (*position_check
)(struct azx
*chip
, struct azx_dev
*azx_dev
);
100 /* enable/disable the link power */
101 int (*link_power
)(struct azx
*chip
, bool enable
);
107 struct hda_codec
*codec
;
108 struct hda_pcm
*info
;
109 struct list_head list
;
112 typedef unsigned int (*azx_get_pos_callback_t
)(struct azx
*, struct azx_dev
*);
113 typedef int (*azx_get_delay_callback_t
)(struct azx
*, struct azx_dev
*, unsigned int pos
);
118 struct snd_card
*card
;
122 /* chip type specific */
124 unsigned int driver_caps
;
125 int playback_streams
;
126 int playback_index_offset
;
128 int capture_index_offset
;
130 const int *jackpoll_ms
; /* per-card jack poll interval */
132 /* Register interaction. */
133 const struct hda_controller_ops
*ops
;
135 /* position adjustment callbacks */
136 azx_get_pos_callback_t get_position
[2];
137 azx_get_delay_callback_t get_delay
[2];
140 struct mutex open_mutex
; /* Prevents concurrent open/close operations */
143 struct list_head pcm_list
; /* azx_pcm list */
146 int codec_probe_mask
; /* copied from probe_mask option */
147 unsigned int beep_mode
;
149 #ifdef CONFIG_SND_HDA_PATCH_LOADER
150 const struct firmware
*fw
;
156 unsigned int running
:1;
157 unsigned int fallback_to_single_cmd
:1;
158 unsigned int single_cmd
:1;
159 unsigned int polling_mode
:1;
161 unsigned int probing
:1; /* codec probing phase */
162 unsigned int snoop
:1;
163 unsigned int uc_buffer
:1; /* non-cached pages for stream buffers */
164 unsigned int align_buffer_size
:1;
165 unsigned int region_requested
:1;
166 unsigned int disabled
:1; /* disabled by vga_switcheroo */
169 unsigned int gts_present
:1;
171 #ifdef CONFIG_SND_HDA_DSP_LOADER
172 struct azx_dev saved_azx_dev
;
176 #define azx_bus(chip) (&(chip)->bus.core)
177 #define bus_to_azx(_bus) container_of(_bus, struct azx, bus.core)
179 static inline bool azx_snoop(struct azx
*chip
)
181 return !IS_ENABLED(CONFIG_X86
) || chip
->snoop
;
185 * macros for easy use
188 #define azx_writel(chip, reg, value) \
189 snd_hdac_chip_writel(azx_bus(chip), reg, value)
190 #define azx_readl(chip, reg) \
191 snd_hdac_chip_readl(azx_bus(chip), reg)
192 #define azx_writew(chip, reg, value) \
193 snd_hdac_chip_writew(azx_bus(chip), reg, value)
194 #define azx_readw(chip, reg) \
195 snd_hdac_chip_readw(azx_bus(chip), reg)
196 #define azx_writeb(chip, reg, value) \
197 snd_hdac_chip_writeb(azx_bus(chip), reg, value)
198 #define azx_readb(chip, reg) \
199 snd_hdac_chip_readb(azx_bus(chip), reg)
201 #define azx_has_pm_runtime(chip) \
202 ((chip)->driver_caps & AZX_DCAPS_PM_RUNTIME)
205 static inline struct azx_dev
*get_azx_dev(struct snd_pcm_substream
*substream
)
207 return substream
->runtime
->private_data
;
209 unsigned int azx_get_position(struct azx
*chip
, struct azx_dev
*azx_dev
);
210 unsigned int azx_get_pos_lpib(struct azx
*chip
, struct azx_dev
*azx_dev
);
211 unsigned int azx_get_pos_posbuf(struct azx
*chip
, struct azx_dev
*azx_dev
);
213 /* Stream control. */
214 void azx_stop_all_streams(struct azx
*chip
);
216 /* Allocation functions. */
217 #define azx_alloc_stream_pages(chip) \
218 snd_hdac_bus_alloc_stream_pages(azx_bus(chip))
219 #define azx_free_stream_pages(chip) \
220 snd_hdac_bus_free_stream_pages(azx_bus(chip))
222 /* Low level azx interface */
223 void azx_init_chip(struct azx
*chip
, bool full_reset
);
224 void azx_stop_chip(struct azx
*chip
);
225 #define azx_enter_link_reset(chip) \
226 snd_hdac_bus_enter_link_reset(azx_bus(chip))
227 irqreturn_t
azx_interrupt(int irq
, void *dev_id
);
229 /* Codec interface */
230 int azx_bus_init(struct azx
*chip
, const char *model
,
231 const struct hdac_io_ops
*io_ops
);
232 int azx_probe_codecs(struct azx
*chip
, unsigned int max_slots
);
233 int azx_codec_configure(struct azx
*chip
);
234 int azx_init_streams(struct azx
*chip
);
235 void azx_free_streams(struct azx
*chip
);
237 #endif /* __SOUND_HDA_CONTROLLER_H */